tt.getImRankData__抖音开放平台

基础库 2.70.0 开始支持本方法，这是一个异步方法。

获取排序好的「好友/总榜」数据源，开发者基于数据源自行渲染返回的数据。

前提条件	无
业务背景	无
使用限制	该方法需要在开放数据域中使用，请访问开放数据域能力介绍进行通信
注意事项	无
相关教程	无

语法

tt.getImRankData(options)

参数说明

options 为 object 类型，属性如下：

属性名	类型	默认值	必填	说明	最低支持版本
zoneId	string	default	否	排行榜分区标识，取值可以是 'default' 或 'test' 或其他开发者自定义字符串。'default' 表示为默认的线上分区，不同分区的排行榜数据存在数据隔离，如 zoneId='test' 设置的数据不会影响通过 zoneId='default' 的排行榜，可用于测试环境。目前每个小游戏除了 default 和 test，最多可支持 10 个分区（未包括默认的线上分区）	2.70.0
dataType	number		是	可选值： 0 或 1。0 表示返回数据被解析为 number。1 表示返回数据被解析为 string	2.70.0
relationType	enum		是	排行榜类型	2.70.0
pageSize	number		是	每页长度，大于 0 小于 40	2.70.0
rankType	string		是	可选值：day、week、month、all	2.70.0
pageNum	number		是	页码，从 1 开始	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 类型，属性如下：

属性名	类型	说明	最低支持版本
data	object	接口调用结果	2.70.0
errMsg	string	"getImRankData:ok"	2.70.0

data 类型说明

object 类型，属性如下：

属性名	类型	说明	最低支持版本
items	array	获取的榜单数据。Array<RankResItem> 类型	2.70.0
self_user_info	object	用户个人信息	2.70.0
self_item	object	请求者自己的数据	2.70.0
page_num	number	页码，从1开始	2.70.0
total_num	number	总条数	2.70.0

self_user_info 类型说明

object 类型，属性如下：

属性名	类型	说明	最低支持版本
openid	string	用户 openid	2.70.0
sec_uid	string	加密后的 sec_uid	2.70.0
user_img	string	用户头像	2.70.0
nick_name	string	用户昵称	2.70.0

self_item 类型说明

object 类型，属性如下：

属性名	类型	说明	最低支持版本
item	object	RankResItem 类型	2.70.0
rank	number	从 1 开始的排序，返回 0 表示不在排行榜内	2.70.0
private_setting	number	隐私设置，0：所有人可见，1：仅好友可见，2：仅自己可见	2.70.0

item 类型说明

object 类型，属性如下：

属性名	类型	说明	最低支持版本
data_type	number	可选值：0 或 1。0 代表 value 为数字类型，1 代表 value 为枚举名称	2.70.0
value	string	分数值或枚举名称，代表分数值时只能传正数	2.70.0
priorty	number	data_type === 1时有意义，返回值为正整数，表示枚举名称对应的权重	2.70.0
extra	string	传入的附加字段，小游戏只负责透传	2.70.0
user_img	string	用户头像	2.70.0
nick_name	string	用户昵称	2.70.0
openid	string	用户的 openid	2.70.0
utime	number	unix秒级时间戳	2.70.0
sec_uid	string	加密后的 uid	2.70.0

回调失败

object 类型，属性如下：

属性名	类型	说明	最低支持版本
errMsg	string	"getImRankData: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

代码示例

tt.getImRankData({
  relationType: "friend",
  dataType: 0,
  rankType: "month",
  pageNum: 1,
  pageSize: 40,
  zoneId: 'default',
  success(res) {
    console.log(`getImRankData success res: ${res}`);
  },
  fail(res) {
    console.log(`getImRankData fail res: ${res.errMsg}`);
  },
});