游戏站礼包接入指引
礼包下发路径概览
技术接入流程
步骤一:消息推送能力接入
游戏站礼包通过消息推送的形式给用户发货,开发者需要在平台上配置好推送的地址,当用户领取礼包时,平台将把请求推送到开发者服务器
步骤二:实现道具发货协议
在具体的发货请求中,有效的 payload 会放在请求的 body 中,开发者可在验签成功后对 body 进行解析,并执行具体的发货业务逻辑。
请求
编码协议:JSON
字段名 | 字段类型 | 必须 | 说明 |
gift_id | int64 | 否 | 发货时对应的礼包ID,正式请求一般有,在道具测试阶段无 |
gift_code | string | 是 | 此次发货使用的礼包码,可用于消息去重 注意 在执行发货时,无法避免同一条发货消息的重复推送,开发者需通过 gift_code 保障幂等(保留24小时即可),避免同一个 gift_code 被多次使用,造成损失 |
open_id | string | 是 | 领奖用户的 open_id |
prop_list | array | 是 | 此次发货的道具列表,正常情况下,开发者需给用户 账号增加这些道具资产 |
prop_list.prop_id | string | 是 | 道具列表中当前道具的道具ID |
prop_list.name | string | 是 | 道具列表中当前道具的道具名称 |
prop_list.count | int64 | 是 | 道具列表中当前道具的发货数量 |
env_type | string | 是 | 发货请求的环境标识 •development:调试环境,使用平台测试推送入口时使用 •production:正式环境,用户正式领取礼包时使用 |
send_time | int64 | 是 | 礼包推送请求触发的秒级时间戳 |
示例:
{ "gift_id": 7461891275051078697, "gift_code": "cdk0000001", "open_id": "_0000-vQJEof2jifeowf1TbzSda6jg", "prop_list": [ { "prop_id": "coin003", "name": "游戏金币", "count": 5 }, { "prop_id": "skin002", "name": "皮肤", "count": 1 } ], "env_type": "production", "send_time": 1737619782 }
响应
正常响应
HTTP 状态码:200
HTTP 响应体:JSON
{ "success": true }
异常响应
HTTP 状态码:200(非200响应可能导致礼包下架, 无法发货请通过下方错误码返回)
HTTP 响应体:JSON
{ "success": false, "err_code": 100001, "reason": "失败原因" }
err_code 错误码枚举:
err_code | 说明 |
100001 | 未注册/未登录/未创建角色,用户未满足领取条件 |
100002 | 触发频控,允许稍后重试 |
步骤三:道具推送测试
推送测试 | 示例图 |
完成道具配置后,可在道具列表点击「道具推送测试」来触发消息推送 | |
请按照提示输入你用来测试的抖音UID,以及本次发货使用的CDKey(也即上面的 gift_code 字段),并选择此次推送的道具,点击确定后,你将在下方的实时日志中看到此次请求的详细内容 注意 这里输入的抖音UID在推送前会转成抖音宿主端对应的 open_id. | |
完成道具推送测试和确认发货能力正常后,可进入礼包列表界面新增游戏站礼包 |
|
步骤四:礼包下发弹窗-告知用户
推送测试 | 示例图 |
•请配合平台,将游戏礼包&道具统一下发到游戏内账号邮箱中,用户可自行进行领取,展示规则如下: ◦icon、名称对齐平台配置礼包名称、道具名称 ◦过期时间需披露 | |
步骤五:配置道具 & 礼包
配置入口:控制台-运营-运营能力-道具&礼包营销-礼包列表-新建礼包-登录/签到礼包
建议配置高价值礼包提升用户转化效果,每日签到小游戏站与每日登录游戏各配置 1 个。
完成礼包上架后需实际去小游戏站内测试领取,包括是否页面提示领取成功、游戏内下发是否正常等。