合并分支 'feat-16417H5捉妖小队游戏内角色行为接入' 到 'release'

Feat 16417 h5捉妖小队游戏内角色行为接入

查看合并请求 zwwl/zw_game_sdk!165

H5_SDK对接说明.md

-# H5 SDK 对接文档-v1.0
+# H5 SDK 对接文档-v1.0
@@ -164,6 +164,20 @@
 
         示例
 
+    3.11 [SDK 角色行为上报](#sec3.11)
+
+        接口说明
+
+        调用方式
+
+        请求参数
+
+        返回参数
+
+        示例
+
+        参数枚举
+
 ## 1. 接入说明<a name="sec1"></a>
 
 ### 1.1 术语表<a name="sec1.1"></a>
@@ -922,4 +936,133 @@ sdk.toRankPage({
     role_name: '哇哦是龙儿',
   }
 })
-```
+```
\ No newline at end of file
+### 3.11 SDK 角色行为上报<a name="sec3.11"></a>
+
+---
+
+##### 接口说明
+> **\***接口返回 Promise 对象
+> 此方法用于上报角色行为，需在角色有对应行为时调用此方法。
+
+##### 调用方式
+
+```javascript
+zwsdk.roleEventReport(config:Object)
+```
+
+##### 请求参数
+
+> | 参数          | 必选 | 类型   | 默认值 | 说明                                                                                                                                    |     |
+> | :------------ | :--- | :----- | :----- | :-------------------------------------------------------------------------------------------------------------------------------------- | --- |
+> | role_name  | true | String      | -      | 角色名称       |
+> | cp_role_id | true | String      | -      | cp角色id       |
+> | event      | true | String      | -      | 事件类型       |
+> | qureys     | true | Array[{name, value}]   | -      | 属性           |
+> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name     | true | String  | -      | 属性名（中文）   |
+> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value    | true | String  | -      | 属性值           |
+
+
+
+##### 返回参数
+
+> | 参数                                                 | 类型   | 说明         |
+> | :--------------------------------------------------- | :----- | :----------- |
+> | status_code                                          | int    | 返回状态 1 成功  2 失败     |
+> | msg                                                  | String | 返回信息     |
+
+##### 示例
+
+```javascript
+zwsdk.roleEventReport({
+        role_name: "角色上报测试",
+        cp_role_id: "111", 
+        event: "coin_get",
+        querys: [
+          {"name":"货币id","value":"123"},
+          {"name":"货币产出途径","value":"掉落"},
+          {"name":"变动前数量", "value":"59"},
+          {"name":"变动数量","value":"32"},
+          {"name":"变动后数量","value":"91"}
+        ]
+      })
+      .then((res) => {
+        // res.status  返回状态
+        // res.msg  返回信息
+      })
+```
+##### 参数枚举
+EVENT枚举
+> | EVENT            | 说明     |
+> | ---------------- | -------- |
+> | coin_get         | 货币产出 |
+> | coin_cost        | 货币消耗 |
+> | item_get         | 道具产出 |
+> | item_cost        | 道具消耗 |
+> | shop             | 商城购买 |
+> | task_complete    | 任务完成 |
+> | newplayer_guide  | 新手指引 |
+> | mail             | 邮件操作 |
+
+EVENT属性对应关系
+> | coin_get 属性名  |
+> | --------------- |
+> | 货币ID      |
+> | 货币产出途径 |
+> | 变动前数量   |
+> | 变动数量     |
+> | 变动后数量   |
+
+> | coin_cost 属性名  |
+> | --------------- |
+> | 货币ID |
+> | 货币消耗途径 |
+> | 变动前数量 |
+> | 变动数量 |
+> | 变动后数量|
+
+> | item_get 属性名  |
+> | --------------- |
+> | 道具ID |
+> | 道具类型 |
+> | 道具产出途径 |
+> | 变动前数量 |
+> | 变动数量|
+> | 变动后数量|
+
+> | item_cost 属性名  |
+> | --------------- |
+> | 道具ID |
+> | 道具类型 |
+> | 道具消耗途径 |
+> | 变动前数量 |
+> | 变动数量|
+> | 变动后数量|
+
+> | shop 属性名  |
+> | --------------- |
+> | 商城ID |
+> | 购买道具ID |
+> | 购买道具数量 |
+> | 消耗货币ID |
+> | 单价|
+> | 消耗货币数量|
+
+> | task_complete 属性名  |
+> | --------------- |
+> | 任务ID |
+> | 任务类型 |
+> | 任务奖励 |
+
+> | newplayer_guide 属性名  |
+> | --------------- |
+> | 步骤ID |
+
+> | mail 属性名  |
+> | --------------- |
+> | 邮件操作类型 |
+> | 邮件ID |
+> | 邮件类型 |
+> | 邮件标题 |
+> | 邮件附件 |
+> | 邮件到期时间 |

SDK对接说明.md

-# 游戏 SDK 对接文档-v1.1.0
+# 游戏 SDK 对接文档-v1.1.0
@@ -206,6 +206,20 @@
 
         示例
 
+    3.15 [SDK 角色行为上报](#sec3.15)
+
+        接口说明
+
+        调用方式
+
+        请求参数
+
+        返回参数
+
+        示例
+
+        参数枚举
+
 ## 1. 接入说明<a name="sec1"></a>
 
 ### 1.1 术语表<a name="sec1.1"></a>
@@ -1309,3 +1323,128 @@ wx.getGameClubData({
   fail: (res) => console.error(res)
 })
 ```
+
+### 3.15 SDK 角色行为上报<a name="sec3.15"></a>
+
+---
+
+##### 接口说明
+> 此方法用于上报角色行为，需在角色有对应行为时调用此方法。
+
+##### 调用方式
+
+```javascript
+zwsdk.roleEventReport(config:Object)
+```
+
+##### 请求参数
+
+> | 参数          | 必选 | 类型   | 默认值 | 说明                                                                                                                                    |     |
+> | :------------ | :--- | :----- | :----- | :-------------------------------------------------------------------------------------------------------------------------------------- | --- |
+> | role_name  | true | String      | -      | 角色名称       |
+> | cp_role_id | true | String      | -      | cp角色id       |
+> | event      | true | String      | -      | 事件类型       |
+> | qureys     | true | Array[{name, value}]   | -      | 属性           |
+> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name     | true | String  | -      | 属性名（中文）   |
+> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value    | true | String  | -      | 属性值           |
+
+
+
+##### 返回参数
+
+> | 参数                                                 | 类型   | 说明         |
+> | :--------------------------------------------------- | :----- | :----------- |
+> | status_code                                          | int    | 返回状态 1 成功  2 失败     |
+> | msg                                                  | String | 返回信息     |
+
+##### 示例
+
+```javascript
+zwsdk.roleEventReport({
+        role_name: "角色上报测试",
+        cp_role_id: "111", 
+        event: "coin_get",
+        querys: [
+          {"name":"货币id","value":"123"},
+          {"name":"货币产出途径","value":"掉落"},
+          {"name":"变动前数量", "value":"59"},
+          {"name":"变动数量","value":"32"},
+          {"name":"变动后数量","value":"91"}
+        ]
+      })
+```
+##### 参数枚举
+EVENT枚举
+> | EVENT            | 说明     |
+> | ---------------- | -------- |
+> | coin_get         | 货币产出 |
+> | coin_cost        | 货币消耗 |
+> | item_get         | 道具产出 |
+> | item_cost        | 道具消耗 |
+> | shop             | 商城购买 |
+> | task_complete    | 任务完成 |
+> | newplayer_guide  | 新手指引 |
+> | mail             | 邮件操作 |
+
+EVENT属性对应关系
+> | coin_get 属性名  |
+> | --------------- |
+> | 货币ID      |
+> | 货币产出途径 |
+> | 变动前数量   |
+> | 变动数量     |
+> | 变动后数量   |
+
+> | coin_cost 属性名  |
+> | --------------- |
+> | 货币ID |
+> | 货币消耗途径 |
+> | 变动前数量 |
+> | 变动数量 |
+> | 变动后数量|
+
+> | item_get 属性名  |
+> | --------------- |
+> | 道具ID |
+> | 道具类型 |
+> | 道具产出途径 |
+> | 变动前数量 |
+> | 变动数量|
+> | 变动后数量|
+
+> | item_cost 属性名  |
+> | --------------- |
+> | 道具ID |
+> | 道具类型 |
+> | 道具消耗途径 |
+> | 变动前数量 |
+> | 变动数量|
+> | 变动后数量|
+
+> | shop 属性名  |
+> | --------------- |
+> | 商城ID |
+> | 购买道具ID |
+> | 购买道具数量 |
+> | 消耗货币ID |
+> | 单价|
+> | 消耗货币数量|
+
+> | task_complete 属性名  |
+> | --------------- |
+> | 任务ID |
+> | 任务类型 |
+> | 任务奖励 |
+
+> | newplayer_guide 属性名  |
+> | --------------- |
+> | 步骤ID |
+
+> | mail 属性名  |
+> | --------------- |
+> | 邮件操作类型 |
+> | 邮件ID |
+> | 邮件类型 |
+> | 邮件标题 |
+> | 邮件附件 |
+> | 邮件到期时间 |