关系链互动数据 | 微信开放文档

# 关系链互动数据

在开放关系链数据能力的基础上，小游戏新增互动型托管数据，提供关系链互动能力，用于实现小游戏内微信好友互动（点赞，送礼物等）的功能。

关系链互动数据能力支持：

好友间互赠 50 种游戏内道具
提供成功互动后的主域回调，满足互动后激励的场景。
开发者配置互动交互文案后，用户可在微信游戏其他场景，获得互动提醒。
用户发起互动后，可通过微信分享消息告诉好友。
从定向分享进入游戏，可向分享发起者发起一次免确认的互动，用于满足分享后激励的场景。

关系链互动能力已支持的场景举例：

以下描述中，金币、皮肤为游戏数据，点赞数为托管数据。
A 与 BC 为微信好友。 B为游戏注册用户；C 为游戏流失或未注册用户。

游戏场景	备注
A 赠送 B 金币，并微信告诉他
A 给 B 赠送金币，A可获得金币奖励
A 微信邀请 C（流失或新用户），C 进入游戏后，A 金币+1，C 金币+1	结合定向分享能力
A 微信向 B 索要点赞，B 进入游戏后给 A 点赞	结合定向分享能力
A 看到好友 B 游戏在线，并向 B 发起对局邀请。	结合游戏状态服务能力

# 互动型托管数据与普通托管数据的对比如下：

	普通托管数据	互动型托管数据
单用户数据大小	每个用户最多 128 个 key，每个 key 对应的 key+value 提供 1kb 存储	每个用户最多 50 个 key，每个 key 对应的 value 只提供1个32位整型存储。
数据来源	开放数据域/主域/后台	开放数据域/后台
数据流向	开放数据域	开放数据域/主域
写入方式	覆盖写	递增(在开放数据域)，覆盖写(后台)
写入时机	任意时机	用户点击弹框确认
写入对象	只能写本人	写好友(在开放数据域)，写本人(后台)
读取对象	任意（本人/好友)	只能读本人

可以看到关系链互动数据可以从小游戏主域直接读取。

提供以下前端接口读写关系链互动数据

wx.getUserInteractiveStorage读取当前用户关系链互动数据
wx.modifyFriendInteractiveStorage修改当前用户好友的关系链互动数据

提供以下后端接口写关系链互动数据

storage.setUserInteractiveData写当前用户的关系链互动数据

# 数据安全性校验

由于互动型托管数据涉及用户好友的游戏业务数据，这里为游戏方提供一种安全的，灵活的校验方式。

微信提供一个后台 JS 运行环境，由开发者上传一段代码，平台方在接受小程序前端发起的写入请求之后执该逻辑，并根据返回结果判断是否要真正执行写入操作。

# 扩展后的关系链开放能力

# 后台JS运行环境JSServer

安全可控的后台JS运行环境
提供读写用户关系链数据的能力

# 接入准备

上传代码要求开发者工具版本(1.02.1908012)及其以上。下载地址

# 代码编写规范要求

定义函数 main

export 函数 main

// checkInteractiveData.js
exports.main = function (req) {
   console.log(req.toUser)
   console.log(req.key)
   console.log(req.opNum)
   const ok = check() // 游戏侧自行实现校验逻辑
   if (ok) {
      // 验证通过
      return JSON.stringify({ "ret": true });
   } else {
      // 验证不通过
      return JSON.stringify({ "ret": false });
   }
}

# 代码上传/下载

工具配置文件 project.config.json 新增配置项

// project.config.json
{
    "jsserverRoot": "jsserver"
}

配置生效后，该目录不参与编译，所以建议该目录不在小游戏代码根目录里。
```
├── game.js
├── jsserver 
│   └── checkInteractiveData.js
```
鼠标右键点击对应目录，可以看到新建JS的选择项，点击即可创建一个JS文件，这里一个JS文件即为一个小游戏前端请求JSServer的入口，文件名即入口标识，如果已经有开发者创建同名JS，会失败, 目前只支持上传checkInteractiveData.js。
工具可以下载该小游戏已经上传的JS代码,分为开发版和正式版。

正式版小程序发起请求会拉取正式版的JSServer代码执行
开发版,体验版小程序以及开发工具发起的请求会拉取开发版的JSServer代码执行
请注意开发版本和正式版本各自只有一份代码

# JSServer提供的开放接口

获取用户本人的openid

接口名：wx.getOpenId()

参数：无

返回：openid
```
let openid = wx.getOpenId()
```
读取用户托管数据存储

接口名：wx.getFriendUserStorage()

参数：Array.< String >

返回：Array.< KVData >
```
//示例：
let friendsStorage = wx.getFriendUserStorage(["friendGift"])
```
需要注意，添加新微信好友后的2小时内，getFriendUserStorage 可能获取不到该新好友的数据。

写用户托管数据存储

接口名：wx.setFriendUserStorage()

参数：openid，Array.< KVData >

返回：{"errcode":0}

//示例：
 let ret = wx.setFriendUserStorage(openid, [{
  key: "friendGift",
  value: JSON.stringify(giftRecords)
}]
)
 if (ret.errcode != 0){
     console.error("set err")//console 所打印的日志会通过接口返回给前端
 }else{
     console.log("set success")
 }

# 备注

JSServer内所有接口均为同步。
JSServer单次处理请求超时时间为1s，超过后任务会被终止。

# 互动型托管数据结合JSServer实现好友互动能力

wx.modifyFriendInteractiveData接口在具体写入操作之前会默认执行开发者托管在JSServer上的一段代码，要求开发者使用开发者工具上传文件checkInteractiveData.js。
- 开发者在checkInteractiveData.js可以拿到参数
  - 用户本人openid:wx.getOpenId()
  - 目标好友openid:toUser
  - 增加的数据:opNum
  - 修改数据的index(1 ~ 50): key
- 要求返回字段bool型 "ret" 字段告诉微信请求是否合法
开发者可以在checkInteractiveData.js中读写普通托管数据来存储用户互动记录。