抖音开放平台Logo
开发者文档
控制台
  • 体验抖音小游戏
  • 游戏引擎
  • Unity 引擎适配
  • WebGL 方案与优化
  • BGDT 手册
  • 接入
  • C# API
  • API 概览
  • 开放能力
  • 账号
  • 侧边栏
  • 收藏
  • 群聊
  • 平台开放能力
  • 游戏互推组件
  • 好友排行榜
  • 数据分析
  • 客服能力
  • 直玩能力
  • 基础
  • 设备
  • 文件
  • 媒体
  • 网络
  • 游戏分享
  • 数据缓存
  • 系统
  • 界面
  • 支付
  • 广告
  • 宿主事件
  • 抖音云模块
  • 邀请模块
  • PlayerPrefs
  • 调试工具
  • 初始化
  • 渲染
  • Cocos/Laya/Egret引擎适配
  • 基础功能
  • 开放能力
  • 性能优化
  • 游戏中好友排行榜相关。
    注意:
    该模块对应 好友排行榜

    TT.SetImRankData

    6.0.0 开始支持本方法
    在关键的游戏场景,设置写入用户的排行榜数据(游戏成绩信息),该数据会上传到服务端。
    前提条件
    业务背景
    使用限制
    注意事项
    字段解释
    相关教程

    语法

    public static void SetImRankData( JsonData paramJson, Action<bool, string> action = null)

    参数说明

    属性名
    类型
    默认值
    必填
    说明
    paramJson
    JsonData
    --
    相关参数使用 json 格式传入,参考 tt.setImRankData__抖音开放平台 例如:"{"dataType":0,"value":"100","priority":0,"zoneId":"default"}"
    action
    Action<bool, string>
    null
    回调函数

    代码示例

    public void TestImRank() { var paramJson = new JsonData { ["dataType"] = xxx, ["value"] = "xxx", ["priority"] = xxx, ["zoneId"] = "xxx" }; Debug.Log($"SetImRankData param:{paramJson.ToJson()}"); TT.SetImRankData(paramJson, (b, s) => { if (b) { Debug.Log("SetImRankData"); } else { Debug.Log("SetImRankData"); } }); }

    TT.GetImRankList

    6.0.0 开始支持本方法
    获取排行榜列表,调用 API 后, 根据参数自动绘制游戏好友排行榜( native UI )。
    前提条件
    在拉起排行榜前,需要调用 TT.Login 接口进行用户登录,否则可能会出现榜单无法拉起或闪退的问题
    业务背景
    使用限制
    注意事项
    排序规则:
    数字类型则按照传入的 value 从大到小排序,若数字大小相同,按照写入时间从早到晚排序
    枚举类型按照权重从高到低排序,若权重相同,按照写入时间从早到晚排序
    参数字段对应解释:
    相关教程

    语法

    public static void GetImRankList(JsonData paramJson, Action<bool, string> action = null)

    参数说明

    属性名
    类型
    默认值
    必填
    说明
    paramJson
    JsonData
    --
    相关参数使用 json格式传入,参考 tt.getImRankList_小游戏_抖音开放平台 例如"{"rankType":"week","dataType":0,"relationType":"all","suffix":"分","rankTitle":"","zoneId":"default"}"
    action
    Action<bool, string>
    null
    回调函数

    代码示例

    public void TestImRank() { var paramJson = new JsonData { ["rankType"] = "xxx", ["dataType"] = xxx, ["relationType"] = "xxx", ["suffix"] = "xxx", ["rankTitle"] = "xxx", ["zoneId"] = "xxx", }; Debug.Log($"GetImRankList param:{paramJson.ToJson()}"); TT.GetImRankList(paramJson, (b, s) => { if (b) { Debug.Log("GetImRankList"); } else { Debug.Log("GetImRankList 2"); } }); }

    TT.GetImRankData

    6.0.0 开始支持本方法
    获取排序好的「好友/总榜」数据源,开发者基于数据源自行渲染返回的数据。
    前提条件
    业务背景
    使用限制
    该方法需要在开放数据域中使用,请访问 开放数据域能力介绍进行通信
    注意事项
    相关教程

    语法

    public static void GetImRankData(JsonData paramJson, TTRank.OnGetRankDataSuccessCallback onGetRankDataSuccessCallback, TTRank.OnGetRankDataFailCallback onGetRankDataFailCallback)

    参数说明

    属性名
    类型
    默认值
    必填
    说明
    paramJson
    JsonData
    --
    相关参数使用 json格式传入,参考 tt.getImRankData_小游戏_抖音开放平台
    onGetRankDataSuccessCallback
    TTRank.OnGetRankDataSuccessCallback
    --
    获取成功回调
    onGetRankDataFailCallback
    TTRank.OnGetRankDataFailCallback
    --
    获取失败回调

    代码示例

    public void TestImRank() { var paramJson = new JsonData { ["relationType"] = "xxx", ["dataType"] = xxxx, ["rankType"] = "xxx", ["pageNum"] = xxxx, ["pageSize"] = xxxxx, ["zoneId"] = "xxxx", }; Debug.Log($"GetImRankDataNew param:{paramJson.ToJson()}"); TT.GetImRankData(paramJson, (ref TTRank.RankData data) => { Debug.Log(data.ToString()); Debug.Log($"data: {data}"); Debug.Log($"data: {data.Items.Count}"); for (var i = 0; i < data.Items.Count; i++) { Debug.Log($"item-->nickName :{data.Items[i].Nickname}, openId:{data.Items[i].OpenId}"); } Debug.Log("GetImRankDataNew true"); }, msg => { Debug.Log("GetImRankData " + msg); }); }