tt.getImRankList__抖音开放平台

基础库 2.70.0 开始支持本方法，抖音&抖 lite 23.2.0 版本后支持，这是一个异步方法。

获取排行榜列表，调用 API 后，根据参数自动绘制游戏好友排行榜（ native UI ）。

前提条件	在拉起排行榜前，需要调用 tt.login 接口进行用户登录，否则可能会出现榜单无法拉起或闪退的问题
业务背景	无
使用限制	无
注意事项	排序规则：数字类型则按照传入的 value 从大到小排序，若数字大小相同，按照写入时间从早到晚排序枚举类型按照权重从高到低排序，若权重相同，按照写入时间从早到晚排序参数字段对应解释：
相关教程	无

语法

tt.getImRankList(options)

参数说明

options 为 object 类型，属性如下：

属性名	类型	默认值	必填	说明	最低支持版本
zoneId	string	default	否	排行榜分区标识，取值可以是 'default' 或 'test' 或其他开发者自定义字符串，'default' 表示为默认的线上分区，不同分区的排行榜数据存在数据隔离，如 zoneId='test' 设置的数据不会影响通过 zoneId='default' 的排行榜，可用于测试环境。目前每个小游戏除了 default 和 test，最多可支持 10 个分区	3.5.0
suffix	string		否	分数后缀补充文案	2.70.0
rankTitle	string		否	排行榜标题	2.70.0
dataType	number		是	可选值有 0 或 1。 0 表示数据被解析为数值。1 表示数据被解析为字符串	2.70.0
relationType	enum		是	排行榜类型	2.70.0
rankType	string		是	可选值有：day、week、month、all	2.70.0
success	function		否	接口调用成功的回调函数	2.70.0
fail	function		否	接口调用失败的回调函数	2.70.0
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）	2.70.0

relationType 的合法值

值	说明	最低支持版本
friend	当前登录用户的好友的游戏数据排行	2.70.0
all	总榜	2.70.0

回调成功

object 类型，属性如下：

属性名	类型	说明	最低支持版本
errMsg	string	"getImRankList:ok"	2.70.0

回调失败

object 类型，属性如下：

属性名	类型	说明	最低支持版本
errMsg	string	"getImRankList:fail" + 详细错误信息	2.70.0

错误码

errNo	errMsg	说明	最低支持版本
21101	user not login	用户未登录	3.5.0
21102	invalid param / invalid rank enum / invalid relation type / zone not exist	server校验参数错误; 传入的分数/排行/关系类型有误; 传入了未知的关系类型; 请求了不存在的分区数据	3.5.0
21103	Internal error	内部错误(包含网络超时)	3.5.0
21105	rank list is showing	当前已展示排行榜，不重复展示	3.5.0
20001	invalid param	必传参数为空/参数类型异常	3.5.0

代码示例

//moba游戏自动生成段位榜
tt.getImRankList({
  relationType: "default", //好友榜、总榜都展示
  dataType: 1, //只圈选type为枚举类型的数据进行排序
  rankType: "day", //每天凌晨0点更新，只对当天0点到现在写入的数据进行排序
  suffix: "", //为空或不填，一般枚举类型不需要填后缀
  rankTitle: "rankTitle", //标题
  zoneId: 'default',
  success(res) {
    console.log(`getImRankData success res: ${res}`);
  },
  fail(res) {
    console.log(`getImRankData fail res: ${res.errMsg}`);
  },
});