# 推荐流直出 游戏就绪场景列表查询
# 1、接口地址
- 此为游戏服务器提供接口,需配置在SDK开放平台(抖音小游戏渠道分包配置:游戏就绪场景列表API)
- 接口按照本文档提供的协议
- 参考推荐流直出小游戏能力接入指引 (opens new window)
# 2、使用场景
WARNING
- 前提:需要使用推荐流直出游戏能力。
- 场景: 以游戏内的高价值信息为深度玩家的召回抓手,使用游戏进程中的不同场景掉落的重点信息进行触达召回。
# 3、接口说明
DANGER
- 非必接
# 4、请求方式
方式:POST
接入方式: 直接接入
请求参数: headers头 Body raw(JSON)
参数类型 | 字段名 | 值类型 | 必填 | 说明 |
---|---|---|---|---|
Body | appId | int | 是 | 产品ID |
Body | timespan | long | 否 | 当前时间戳,秒,前后2小时有效 |
Body | sign | long | 是 | 接口加密签名md5("appid=" + appid + "&mainChannel=" + mainChannel + "&openId=" + openId + "&secondChannel=" + secondChannel + "×pan" + timespan + appkey) |
Body | mainChannel | int | 是 | sdk配置的主渠道ID |
Body | secondChannel | int | 是 | sdk配置的次渠道ID |
Body | openId | string | 是 | 抖音小游戏的用户open_id |
# 5、接口响应说明
- 请求示例
{"appId":1363299671,"sign":"1236c84d2332bb1d9716585f2803864e","timespan":1742441232,"mainChannel":100774,"secondChannel":100775,"openId":"_0c071Rose4vzWaGGNvgezdFEhksQIAzpFRY",}
响应结果JSON格式
{ "data": { "scenes": [ { "content_ids": [ "CONTENT27648287" ], "extra": "", "scene": 1 }, { "content_ids": [ "CONTENT27648031" ], "extra": "", "scene": 2 } ] }, "err_msg": "推送抖音失败", "err_no": 0, "rid": "sidysubscribenotifi.9ce86a75cd4a4bb090da7ffabf78ff7b" }
返回说明:
参数类型 | 字段名 | 必填 | 值类型 | 说明 | 备注 |
---|---|---|---|---|---|
result | err_no | int | 是 | 响应值 | 0发送消息成功,其它失败 |
result | err_msg | 是 | string | 提示信息 | |
result | rid | string | 是 | response identifies(响应唯一标识) | |
result | data | T | 是 | 响应体的业务数据字段 | 抖音接入文档 (opens new window) |
result | data-> scenes | array | 是 | 就绪状态的场景对象列表,场景值定义见下述scene结构章节 | |
result | data-> scenes-> scene | long | 是 | 就绪的场景值:1: 离线收益场景,2: 体力恢复场景,3: 重要事件掉落 | |
result | data-> scenes-> content_ids | array | 是 | 就绪场景对应自定义文案ID列表,由开发者向抖音平台申请生成 | |
result | data-> scenes-> extra | string | 否 | 开发者可为每个场景携带额外的信息,类型是字符串,要求字符串长度 < 100 |