tt.getCloudStorageByRelation
该接口只可在开放数据域下使用 在主域下使用 tt.login 确认当前用户登录后才能使用
根据关系类型获取与当前用户相关的其他用户托管数据。
参数
Object object
| 名称 | 数据类型 | 属性 | 必填 | 描述 |
|---|
| type | string | | 是 | 关系类型 |
| keyList | Array<string> | | 是 | 要获取的 key 列表 |
| extra | object | | 否 | 获取挑战排行榜数据时需要传的配置 |
| success | function | | 否 | 接口调用成功回调函数 |
| fail | function | | 否 | 接口调用失败回调函数 |
| complete | function | | 否 | 接口调用结束回调函数 |
type 说明
| 值 | 说明 |
|---|
| friend | 好友关系 |
| recommend | 平台推荐部分用户 |
| group | 群 |
extra 属性说明
| 属性 | 类型 | 说明 |
|---|
| sortKey | string | 后台配置的排行榜 key |
| groupId | string | 用户分组 id |
success 返回参数说明
Object 类型， 属性如下：
代码
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("获取数据失败");
}
});
Bug & Tips
- types 属性中的各类型关系均需要宿主 APP 支持后，开发者才可调用接口获取到有效数据。目前关系数据接口仅在抖音 APP 下可用，在头条中使用暂时无法获取有效数据，只能获取用户自身数据。