抖音开放平台Logo
开发者文档
控制台
  • API 概览
  • 开放能力
  • 登录
  • 社交转发裂变
  • 用户信息及授权
  • 小游戏收藏
  • 群聊
  • 关注
  • 游戏互推组件
  • 添加到桌面
  • 游戏排行榜
  • 数据分析
  • 视频拍摄器
  • 订阅消息
  • 关系链
  • 开放数据域
  • 开放数据
  • tt.getCloudStorageByRelation
  • tt.setUserCloudStorage
  • tt.getUserCloudStorage
  • tt.removeUserCloudStorage
  • tt.getSharedCanvas
  • KVData
  • 开放数据分组
  • 客服能力
  • 侧边栏能力
  • 推荐流直出游戏能力
  • 基础
  • 渲染
  • 设备
  • 文件
  • 位置
  • 媒体
  • 网络
  • 游戏转发分享
  • 实时语音
  • 数据缓存
  • 系统
  • 广告
  • 界面
  • 支付
  • Worker
  • tt.getUserCloudStorage
    收藏
    我的收藏

    基础库 1.11.0 开始支持本方法,这是一个异步方法。

    获取当前用户托管数据当中对应 key 的数据。

    前提条件
    业务背景
    使用限制
    该接口只可在开放数据域下使用
    注意事项
    相关教程

    语法

    tt.getUserCloudStorage(options)

    参数说明

    options 为 object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    keyListArray<string>

    要获取的 key 列表

    1.11.0
    successfunction
    接口调用成功的回调函数
    1.11.0
    failfunction
    接口调用失败的回调函数
    1.11.0
    completefunction
    接口调用结束的回调函数(调用成功、失败都会执行)
    1.11.0

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    KVDataList​array

    用户托管的 KV 数据列表​。数据类型为 KVData 类型

    1.11.0
    errMsgstring

    "getUserCloudStorage:ok"

    1.11.0

    回调失败

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring

    "setUserCloudStorage:fail" + 详细错误信息

    1.11.0

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    999998get session id failed.D
    1.11.0
    999987feature is not supported in appD
    1.11.0
    999999keyList is nullD
    1.11.0
    106502*F
    小游戏框架内部错误,有需要请创建工单咨询
    1.11.0
    106501response json doesn't have `data` fieldF
    小游戏框架内部错误,有需要请创建工单咨询
    1.11.0
    999991internal error/网络请求非200F
    小游戏框架内部错误,有需要请创建工单咨询
    1.11.0
    999985network unavailableU
    1.11.0
    999993internal errorF
    小游戏框架内部错误,有需要请创建工单咨询
    1.11.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例

    开发者工具中预览

    tt.getUserCloudStorage({ keyList: ["xxx"], // 要获取的 key 列表 success: (res) => { console.log("调用成功"); console.log(res.KVDataList); }, fail: (res) => { console.log("调用失败"); }, complete: (res) => { console.log("调用完成"); }, });