feat: 增加角色行为上报

README_KS.md

@@ -258,6 +258,20 @@
 
         示例
 
+    3.19 [SDK 角色行为上报](#sec3.19)
+
+        接口说明
+
+        调用方式
+
+        请求参数
+
+        返回参数
+
+        示例
+
+        参数枚举
+
 ## 1. 接入说明<a name="sec1"></a>
 
 ### 1.1 术语表<a name="sec1.1"></a>
@@ -843,6 +857,8 @@ zwSDK
       cp_order_id: '10001',
       product_price: '1',
       amount: '1',
+      subsidy_money: '0',
+      subsidy_after_money: '0',
       product_id: '1000000001',
       product_cnt: '1',
       product_name: '金币',
@@ -1554,3 +1570,131 @@ zwsdk.getSubsidy({ cp_role_id: 'xxx' }).then((res) => {
   // res.data.data  返回数据
 })
 ```
+
+### 3.19 SDK 角色行为上报<a name="sec3.19"></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      |
+> | 邮件类型     |
+> | 邮件标题     |
+> | 邮件附件     |
+> | 邮件到期时间 |
\ No newline at end of file