tt.getCloudStorageByRelation
收藏我的收藏
基础库 1.11.0 开始支持本方法,这是一个异步方法。
根据关系类型获取与当前用户相关的其他用户托管数据。
| 前提条件 | 在主域下使用 tt.login 确认当前用户登录后才能使用 |
| 业务背景 | 无 |
| 使用限制 | 目前关系数据接口仅在抖音 APP 下可用,在头条中使用暂时无法获取有效数据,只能获取用户自身数据。 |
| 注意事项 |
|
| 相关教程 | 无 |
语法
tt.getCloudStorageByRelation(options)
参数说明
options 为 object 类型,属性如下:
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| type | enum | 是 | 关系类型 | 1.11.0 | |
| keyList | Array<string> | 是 | 要获取的 key 列表 | 1.11.0 | |
| extra | object | 否 | 获取挑战排行榜数据时需要传的配置 | 1.11.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 1.11.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.11.0 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 1.11.0 |
type 的合法值
| 值 | 说明 | 最低支持版本 |
|---|---|---|
| friend | 好友关系 | 1.11.0 |
| recommend | 平台推荐部分用户 | 1.11.0 |
| group | 群,当 type == 'group'时,传入参数extra中的 sortKey 和 groupId 两个字段必传 | 1.11.0 |
extra 类型说明
object 类型,属性如下:
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| sortKey | string | 否 | 后台配置的排行榜 key | 1.11.0 | |
| groupId | string | 否 | 用户分组 id | 1.11.0 |
回调成功
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| avatarUrl | string | 用户头像 url | 1.11.0 |
| nickname | string | 用户昵称 | 1.11.0 |
| openid | string | 用户的 openid | 1.11.0 |
| KVDataList | array | 用户的托管 KV 数据列表。数据类型为 KVData | 1.11.0 |
回调失败
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "getCloudStorageByRelation:fail" + 详细错误信息 | 1.11.0 |
错误码
| errNo | errMsg | 说明 | 最低支持版本 |
|---|---|---|---|
| 10401 | get session id failed. | 小游戏框架内部错误,有需要请创建工单咨询 | 1.11.0 |
| 10301 | feature is not supported in app | 1.11.0 | |
| 20000 | type is null | 1.11.0 | |
| 21000 | 网络错误 | 小游戏框架内部错误,有需要请创建工单咨询 | 1.11.0 |
| 21000 | respo | 小游戏框架内部错误,有需要请创建工单咨询 | 1.11.0 |
| 10401 | platform auth deny | 小游戏框架内部错误,有需要请创建工单咨询 | 1.11.0 |
| 10101 | invalid scope | 小游戏框架内部错误,有需要请创建工单咨询 | 1.11.0 |
| 10200 | system auth deny | 好友关系授权校验 | 1.11.0 |
| 10200 | auth deny | 好友关系授权校验 | 1.11.0 |
| 10401 | internal error/网络请求非200 | 小游戏框架内部错误,有需要请创建工单咨询 | 1.11.0 |
| 10103 | network unavailable | 1.11.0 | |
| 10402 | native exception | 小游戏框架内部错误,有需要请创建工单咨询 | 1.11.0 |
| 20000 | internal error | 小游戏框架内部错误,有需要请创建工单咨询 | 1.11.0 |
扫码体验
请使用字节宿主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: ["ranlList"], extra: { sortKey: "ranlList", // 指定的key需要在后台配置过 groupId: "test_group", // 指定要获取的用户所属分组 }, success: (res) => { console.log("调用成功"); console.log(res.data); }, fail: (res) => { console.log("调用失败"); }, complete: (res) => { console.log("调用完成"); }, });
