普通小游戏开发
API
开放能力
数据分析
视频拍摄器
多端支持

tt.getCloudStorageByRelation

基础库 1.11.0 开始支持本方法,低版本需做兼容处理。 目前不支持的该能力的宿主端:西瓜视频,火山视频。

在主域下使用 tt.login 确认当前用户登录后才能使用

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

语法

tt.getCloudStorageByRelation(options);

参数说明

options 为 object 类型, 属性如下:

属性类型默认值必填说明
typestring关系类型
keyListArray要获取的 key 列表
extraobject获取挑战排行榜数据时需要传的配置
successFunction接口调用成功回调函数
failFunction接口调用失败回调函数
completeFunction接口调用结束回调函数

type 的取值说明

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

extra 属性说明

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

success 回调函数的参数说明

参数为 object 类型, 属性如下:

属性类型描述
dataArray<object>宿主 APP 中相关用户的托管数据
errMsgstring接口调用成功的状态信息

data 列表中的对象属性如下:

属性类型说明
avatarUrlstring用户头像 url
nicknamestring用户昵称
openidstring用户的 openid
KVDataListArray<KVData>用户的托管 KV 数据列表

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

// 获取关系类型为friend的用户托管数据(非排行榜)
tt.getCloudStorageByRelation({
  type: "friend",
  keyList: ["score"],
  success: (res) => {
    console.log("调用成功");
    console.log(res.data);
  },
  fail: (res) => {
    console.log("调用失败");
  },
  complete: (res) => {
    console.log("调用完成");
  },
});

// 获取关系类型为group的挑战排行榜数据
tt.getCloudStorageByRelation({
  type: "group",
  keyList: ["score"],
  extra: {
    sortKey: "score", // 指定的key需要在后台配置过
    groupId: "test_group", // 指定要获取的用户所属分组
  },
  success: (res) => {
    console.log("调用成功");
    console.log(res.data);
  },
  fail: (res) => {
    console.log("调用失败");
  },
  complete: (res) => {
    console.log("调用完成");
  },
});

Bug & Tips

  • Tip:types 属性中的各类型关系均需要宿主 APP 支持后,开发者才可调用接口获取到有效数据。目前关系数据接口仅在抖音 APP 下可用,在头条中使用暂时无法获取有效数据,只能获取用户自身数据。
  • Tip:该接口一次最多返回 100 个同玩好友的托管数据。
  • Tip:如果你希望获取有序的排行榜数据,请使用 type=group
  • Tip:该方法数据源来自 tt.setUserCloudStorage。但与 tt.getUserCloudStorage 不同,通过该接口获取的数据会经过服务器处理,额外返回好友在同个小游戏中,储存在具有相同 keylist 的数据。
点击纠错
评价此篇文档