游戏排行榜接入指南

sdk提供了游戏排行榜的功能，具体可根据不同的使用情况，接入不同的排行榜单。
注意：单机游戏的榜单ID，需要在后台配置，具体请联系对接人员。

上报游戏排行信息（单机游戏）

调用sdk的postRankInfo方法，将当前游戏的分数上报到平台的排行榜中，具体参入的参数如下。

参数名 类型 说明
id Int 排行榜单的ID号
value String 游戏上报的分数
success Function 获取成功的后的回调
fail Function 获取失败的后的回调

示例代码：

sdk.postRankInfo({
  id: 123,
  value:'666',
  success:function (res) {
    // 上报成功
  },
  fail:function (res) {
    // 上报失败
  }
});

获取游戏排行榜（单机游戏）

调用sdk的getRankInfo方法，将获取当前游戏的排行榜，具体参入的参数如下。

参数名 类型 说明
id Int 排行榜单的ID号
page Int 排行榜的页数（默认是0）
bef Boolean 是否上一季的数据（默认是false）
success Function 获取成功的后的回调
fail Function 获取失败的后的回调

示例代码：

sdk.getRankInfo({
  id: 123,   // 定义的榜单ID
  bef:true,
  page:0,
  success:function (res) {
    console.log('获取到的排行数据：',res)
  },
  fail:function (res) {
    // 获取失败
  }
});

获取游戏的排行榜（对战游戏）

此接口是接入了对战SDK的游戏使用，调用sdk的getTinyRankInfo方法，将获取当前游戏的排行榜，具体参入的参数如下。

参数名 类型 说明
type Int 排行榜的类型，0：默认当前游戏排行榜，1：上期该游戏排行榜，2：该游戏总榜
page Int 排行榜的页数（默认是0）
success Function 获取成功的后的回调
fail Function 获取失败的后的回调

示例代码：

sdk.getTinyRankInfo({
  type: 0,   // 排行榜的类型
  page:0,
  success:function (res) {
    console.log('获取到的排行数据：',res)
  },
  fail:function (res) {
    // 获取失败
  }
});

微信好友排行榜接入

如果排行榜需要基于微信好友的，请参阅《微信关系链数据域使用指南》。