抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • JavaScript API
  • API 概览
  • 基础
  • 界面
  • 渲染
  • 数据缓存
  • 文件
  • 位置
  • 设备
  • 网络
  • 媒体
  • Worker
  • 数据分析
  • 支付
  • 广告
  • 开放能力
  • 登录
  • 侧边栏能力
  • 设置
  • 授权
  • 添加到桌面
  • 游戏排行榜
  • 订阅消息
  • 开放数据域
  • 开放数据
  • 开放数据分组
  • 数据分组实现游戏排行
  • tt.setUserGroup
  • 客服消息
  • 直播能力
  • 推荐流直出游戏能力
  • 社交互动能力
  • 公会群能力
  • 意见反馈
  • 游戏站
  • 转发
  • 关注
  • 群聊
  • 收藏
  • C# API
  • 除了平台开放的通用组件游戏排行榜能力介绍无需开发者进行二次开发之外,平台也提供了基于开放数据域的排行榜功能,开发者通过平台将用户分组标识配置为排行榜标识后,即可筛选处理数据后自行完成 UI 的设置

    使用步骤说明

    ​
      1.登录开发者管理后台后,在「运营能力-排行榜配置-数据分组配置」中完成配置
      2.设置用户分组
      3.完成规范格式的后台数据上报
      4.开发者在业务代码中获取数据
    获取排行榜数据接口文档: tt.getCloudStorageByRelation

    示例

    下面以一个通过数据分组完成游戏排行榜功能的例子做代码解释。
      1.在主域中设置在排行榜功能设置标识。groupId的生成完全由开发者决定,需结合开发者自身策略来确保其唯一性。
    该步骤必须确保是在上报游戏数据前执行,若在上报数据结果后执行,上报的结果将无法同步更新排行榜数据。
    tt.setUserGroup({ groupId: "test_group", });
      2.按照规范上报游戏数据。
    配置了数据分组后,排行榜 key 对应的数据结构需要符合相应规范。详见 KVData。
    const data = { ttgame: { //这里对象里面的score 和 update_time 两个key都是固定的。 score: 16, update_time: +new Date(), }, cost_ms: 36500, }; tt.setUserCloudStorage({ KVDataList: [ // 这里key 需要在开发者后台配置,且配置为排行榜标识后,data 结构必须符合要求,否则会 set 失败 { key: "userrank", value: JSON.stringify(data) }, ], });
      3.获取用户排行榜数据。
    tt.getCloudStorageByRelation({ type: "group", keyList: ["userrank"], extra: { sortKey: "userrank", // 指定的key需要在后台配置过 groupId: "test_group", // 指定要获取的用户所属分组 }, success(res) { console.log(res); }, fail(e) { console.log("获取数据失败"); }, });

    Bug & Tip

      •Tip: 数据分组相关的接口要在调用前保证用户在主域中已经登录。getCloudStorageByRelation 只能在开放数据域中使用,setUserCloudStorage 支持在主域和开放数据域中使用,setUserGroup 只在主域中可用。
    ​