抖音开放平台Logo
控制台

setUserStorage

更新时间 2024-07-24 02:58:49
收藏
我的收藏

接口说明

以 key-value 形式存储用户数据到小程序平台的云存储服务。若开发者无内部存储服务则可接入，免费且无需申请。一般情况下只存储用户的基本信息，禁止写入大量不相干信息。


Bug&Tip

  • Tip：当 key 是开发者所配置的排行榜 key 时，value 的内容应该满足KVData所指出的形式，必须是 string 类型，不要传 json struct。
  • Tip: 该方法为服务端方法，实际方法效果与前端接口 tt.setUserCloudStorage 一致。通过该接口设置数据后，可以在前端通过 tt.getUserCloudStorage 或 tt.getCloudStorageByRelation 获取。

基本信息

名称描述
HTTP URL
https://minigame.zijieapi.com/mgplatform/api/apps/set_user_storage
HTTP Method
POST
Scope
open.ttgame.mgplatform

请求头

名称字段类型是否必填示例描述
content-typeString是application/json
固定值"application/json"

请求参数

Query

名称字段类型是否必填示例描述
access_tokenString是08011218462b6b4b5054626e426e50685a7554643144644449413d3d
调用https://minigame.zijieapi.com/mgplatform/api/apps/v2/token生成的token
openidString是

登录用户唯一标识 获取方法

sig_methodString是hmac_sha256

用户登录态签名的编码方法，参考用户登录态签名算法

signatureString是

用户登录态签名，参考用户登录态签名算法

Body

名称字段类型是否必填示例描述

请求示例

curl -X POST \
 -H "content-type: application/json" \
 -d '{"kv_list":[{"key":"test","value":"{\"ttgame\":{\"score\":1}}"}]}' \
https://minigame.zijieapi.com/mgplatform/api/apps/set_user_storage?access_token=080112***********513d3d&openid=v********oFR9&sig_method=hmac_sha256&signature=44b5092fa1c9adba03803239934d4958b8a1840adf0cee8d5e95c1cf5d495e0e

响应参数

Body

名称字段类型是否必填示例描述
errorInt32是
错误号, 正确返回时为 0
errcodeInt32否
详细错误号
errmsgString否
错误信息
messageString否
错误信息（同 errmsg）

响应示例

正常响应示例

{
  "error": 0
}

异常响应示例

{
  "errcode": 40002,
  "errmsg": "nil access_token",
  "error": 1,
  "message": "nil access_token"
}

错误码

http状态码错误码错误码描述排查建议
2000
请求成功
200-1
系统错误
20040009
key 长度大于 128 个字节
20040010
key 和 value 的长度和大于 1024 个字节
20040011
排行榜 key 对应的 value 值格式不对，具体见 warning
20060001
单用户存储 kv 超过 128 对