tt.getCloudStorageByRelation 1.11.0+

该接口只可在开放数据域下使用

根据关系类型获取与当前用户相关的其他用户托管数据。

输入

Object object

继承标准对象输入,扩展属性描述:

名称 数据类型 属性 默认值 描述
type string 关系类型
keyList Array<string> 要获取的 key 列表
extra object 获取挑战排行榜数据时需要传的配置

type 说明

说明
friend 好友关系
recommend 平台推荐部分用户
group

extra 属性说明

属性 类型 说明
sortKey string 后台配置的排行榜 key
groupId string 用户分组 id

以上各类型关系均需要宿主APP 支持后,开发者才可调用接口获取到有效数据。目前关系数据接口仅在抖音APP下可用,在头条中使用暂时无法获取有效数据,只能获取用户自身数据。

输出

成功回调参数 Object res 的扩展属性:

名称 数据类型 描述
data Array<UserGameData> 宿主APP中关系好友的托管数据
tt.getCloudStorageByRelation({
  type: 'friend',
  keyList: ['test1'],
  success(res){},
  fail(e){}
})

获取挑战排行榜数据

tt.getCloudStorageByRelation({
  type: 'group', 
  keyList: ['score'],
  extra: {
    sortKey: 'score',   // 指定的key需要在后台配置过
    groupId: 'test_group'   // 指定要获取的用户所属分组
  },
  success(res){
    console.log(res);
  },
  fail(e){
    console.log('获取数据失败');
  }
})