抖音直玩能力
业务场景
- 查询指定用户存在待促活事件的场景列表,以便激活推荐流直出游戏能力。
- 当用户符合直玩游戏出卡条件时,抖音平台会调用接口来拉取场景列表,根据一定策略排序选取最优场景,将结合厂家信息的游戏分发到推荐流中。
注意事项
- 游戏方需要提供一个服务端接口地址,单次查询耗时不能超过200毫秒
- 查询耗时太长会导致不出直玩游戏,开发人员需要做好接口的性能优化和测试工作
- 必须保证返回的场景在游戏内一定是就绪状态(如:若该用户游戏内无离线收益,则不可返回表示离线收益就绪的状态),如果因为”货不对板“引起客诉,抖音平台会封禁游戏的直玩能力
- gameid 值,是益世界的项目ID标识,不是出包的 appid
流程图
接口地址
地址由CP提供
接口说明
- 协议:HTTPS
- 方式:POST
- ContentType:application/json;charset=utf-8
- 请求报文:
字段 | 类型 | 必需 | 参与签名 | 说明 |
---|---|---|---|---|
gameid | long | 是 | 是 | 游戏项目ID(并非出包的 appId) |
openid | string | 是 | 是 | SDK用户唯一标识 |
extra | string | 否 | 不一定 | 扩展字段,json 字符串 |
timestamp | long | 是 | 是 | 毫秒时间戳 |
sign | string | 是 | 否 | 签名 |
- 响应报文:
字段 | 类型 | 必需 | 说明 |
---|---|---|---|
code | int | 是 | 状态码:0代表成功,非0代表错误 |
msg | string | 是 | 响应描述 |
data | object | 否 | 结果数据 |
data结构体
字段 | 类型 | 必需 | 说明 |
---|---|---|---|
scenes | array | 是 | 就绪状态的场景对象列表,场景值定义见下述scene结构章节 |
scenes结构体
字段 | 类型 | 必需 | 说明 |
---|---|---|---|
scene | int | 是 | 就绪的场景值:1、离线收益场景, 2、体力恢复场景, 3、重要事件掉落 |
contentIds | array | 是 | 就绪场景对应的自定义文案ID列表,由CP向抖音开放平台申请生成 |
extra | string | 是 | 每个场景可携带的扩展信息,字符串长度不能超过100 |
请求示例
{
"gameid": 123456,
"openid": "12345678912345678912345",
"extra": "",
"timestamp": 1654142913840,
"sign": "8ef6513ba5412ee3c7c5b394daa1e76f"
}
响应示例
{
"code": 0,
"msg": "success",
"data": {
"scenes": [{
"scene": 1,
"contentIds": ["CONTENT123", "CONTENT456"],
"extra": "test1"
}, {
"scene": 2,
"contentIds": ["CONTENT789"],
"extra": "test2"
}]
}
}
签名规则
- 参数名区分大小写,按 ASCII 码从小到大排序(字典序)
- 只有值为 null 和名为 sign 的键值对,才不参与签名
- 使用 URL 键值对的格式,拼接成待签名字符串,签名 key 在最后拼接
- 将生成的签名与入参 sign 值作校验,验签忽略大小写
String sign = md5(k1=v1&k2=v2&k3=v3...&key=appKey);
调试示例
import cn.hutool.crypto.SecureUtil;
import java.util.HashMap;
import java.util.Map;
import java.util.TreeMap;
public class SignExample {
public static String getMd5Sign(Map<String, Object> params, String appKey) {
TreeMap<String, Object> sortedParams = new TreeMap(params);
StringBuilder builder = new StringBuilder(512);
sortedParams.forEach((k, v) -> {
if (v != null) {
builder.append(k).append("=").append(v).append("&");
}
});
builder.append("key=").append(appKey);
return SecureUtil.md5(builder.toString());
}
public static void main(String[] args) {
String appKey = "AaBbCcDdEeFfGgHh";
Map<String, Object> reqMap = new HashMap<>();
reqMap.put("gameid", 123456L);
reqMap.put("openid", "12345678912345678912345");
reqMap.put("extra", "");
reqMap.put("timestamp", 1654142913840L);
System.out.println(String.format("直玩签名:%s", getMd5Sign(reqMap, appKey)));
}
}