# storage.setUserStorage

本接口应在服务器端调用，详细说明参见服务端 API。

本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载），wx-server-sdk >= 0.4.0

上报用户数据后台接口。小游戏可以通过本接口上报 key-value 数据到用户的 CloudStorage。

调用方式：

• HTTPS 调用
• 云调用

# HTTPS 调用

# 请求地址

POST https://api.weixin.qq.com/wxa/set_user_storage?access_token=ACCESS_TOKEN&signature=SIGNATURE&openid=OPENID&sig_method=SIG_METHOD

# 请求参数 - Query

# 请求参数 - Body

kv_list 的结构

# 返回值

# Object

返回的 JSON 数据包

errcode 的合法值

# 示例代码

curl -d '{"kv_list":[{"key":"score","value":"{\"wxgame\":{\"score\":16,\"update_time\":1513080573}}"},{"key":"gold","value":"3000"}]}' 'https://api.weixin.qq.com/wxa/set_user_storage?access_token=ACCESS_TOKEN&signature=SIGNATURE&openid=OPENID&sig_method=SIG_METHOD'

# 托管数据的限制

如果在上报数据时触发这些限制，设置数据会失败并且会收到带错误码的返回包。

1. 每个 openid 所标识的微信用户，在游戏当中的托管的数据不能超过 128 个 key-value 对。
2. 上报的 key-value 列表当中每一项的 key+value 长度都不能超过 1K(1024)字节。
3. 上报的 key-value 列表当中每一个 key 长度都不能超过 128 字节。

# 将排行榜显示在小游戏中心

若开发者希望把游戏的排行榜显示于小游戏中心，则需要把排行榜数据存储到对应的 key/value 中，一个排行榜数据对应一个 key，多个排行榜则多个 key。同时在 mp.weixin.qq.com 的小游戏管理后台“游戏能力地图-特色能力-微信排行榜配置”下配置对应的 key 以及相关排行榜属性。且 value 的内容必须是 JSON Object 格式序列化的字符串，该 JSON Object 顶层必须包含 wxgame 字段，定义如下：

注意： wxgame下开发者不可自定义其他字段， wxgame同级开发者可自由定义，比如定义一个detail 字段，用于存储取得该分数的中间状态。

# 举例

比如某小游戏有一个分数排行榜，分数排行榜需要记录分数以及获得分数的耗时（游戏内的排行榜需要展示耗时），可以在wxgame同级别定义一个cost_ms字段，存储耗时的毫秒数。 分配一个不和已定义的托管数据的 key 相冲突的 key 作为分数排行榜的 key，如 "score"。

在玩家耗时 36500ms 后，获得本周最高分 16 分，则需要更新分数，假设当前时间戳为 1513080573， 则完整 value 在序列化之前的内容如下：

{
  "wxgame": {
    "score": 16,
    "update_time": 1513080573
  },
  "cost_ms": 36500
}

最终序列化为 string 后，value 为{\"wxgame\":{\"score\":16,\"update_time\": 1513080573},\"cost_ms\":36500}。

# 云调用

云调用是微信云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。

# 接口方法

openapi.storage.setUserStorage;

需在 config.json 中配置 storage.setUserStorage API 的权限，详情

# 请求参数

kvList 的结构

# 返回值

# Object

返回的 JSON 数据包

errCode 的合法值

# 异常

# Object

抛出的异常

errCode 的合法值

# SDK 调用示例

// cloud = require('wx-server-sdk')
// ...
// 方法返回 Promise
cloud.openapi.storage.setUserStorage({
  openid: 'xxx',
  kvList: [
    {
      key: 'a',
      value: 1,
    },
    {
      key: 'b',
      value: 2,
    },
  ],
});