Skip to content

Z
zw_game_sdk
提交 fadb83a3 作者: 张梦磊
操作

H5_SDK增加新的回调方法

上级 a704bb5c
正在显示 包含 110 行增加 和 102 行删除
H5_SDK对接说明.md
# H5 SDK 对接文档-v1.0
# H5 SDK 对接文档-v1.0
......@@ -554,7 +554,7 @@ payNotify();
##### 导入示例
> ```javascript
> <script src='https://sdk.zwnet.cn/h5_sdk.js?v=1.1'></script>
> <script src='https://sdk.zwnet.cn/h5_sdk.js?v=1.4'></script>
> ```
### 3.2 H5 SDK 初始化<a name="sec3.2"></a>
......@@ -575,6 +575,9 @@ payNotify();
> ```javascript
> const sdk = new zwsdk({
> gameInfoCallBack: (e) => {
> //处理版号信息 e.data.version_text
> },
> updateRoleCallBack: (e) => {
> //处理角色上报的结果
> },
......@@ -907,7 +910,7 @@ sdk.getLocalStorage({
##### 接口说明
> 用户在点击排行榜按钮(或链接) 将角色信息和服务器信息通过参数传入sdk
> 用户在点击排行榜按钮(或链接) 将角色信息和服务器信息通过参数传入 sdk
##### 调用方式
......@@ -917,13 +920,13 @@ zwsdk.toRankPage(config:Object)
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------------------------------------------------------ | :---- | :----- | :------- | :--------------------------------------------------------------------------------------------------- |
> | role | true | Object | - | 角色相关 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;server_id | true | String | "" | 游戏服务器 ID |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;server_name | true | String | "" | 游戏服务器名称 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cp_role_id | true | String | "" | 玩家角色 ID |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;role_name | true | String | "" | 玩家角色名称 |
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :---------------------------------------------------------- | :--- | :----- | :----- | :------------- |
> | role | true | Object | - | 角色相关 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;server_id | true | String | "" | 游戏服务器 ID |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;server_name | true | String | "" | 游戏服务器名称 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cp_role_id | true | String | "" | 玩家角色 ID |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;role_name | true | String | "" | 玩家角色名称 |
##### 示例
......@@ -933,15 +936,17 @@ sdk.toRankPage({
server_id: '100001',
server_name: '主宰服',
cp_role_id: 'cp_role_id',
role_name: '哇哦是龙儿',
role_name: '哇哦是龙儿'
}
})
```
### 3.11 SDK 角色行为上报<a name="sec3.11"></a>
---
##### 接口说明
> **\***接口返回 Promise 对象
> 此方法用于上报角色行为，需在角色有对应行为时调用此方法。
......@@ -953,116 +958,119 @@ 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 | - | 属性值 |
> | 参数 | 必选 | 类型 | 默认值 | 说明 | |
> | :---------------------------------------------------- | :--- | :------------------- | :----- | :------------- | --- |
> | 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 | 返回信息 |
> | 参数 | 类型 | 说明 |
> | :---------- | :----- | :--------------------- |
> | 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 返回信息
})
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 |
> | 货币消耗途径 |
> | 变动前数量 |
> | 变动数量 |
> | 变动后数量|
EVENT 枚举
> | EVENT | 说明 |
> | --------------- | -------- |
> | coin_get | 货币产出 |
> | coin_cost | 货币消耗 |
> | item_get | 道具产出 |
> | item_cost | 道具消耗 |
> | shop | 商城购买 |
> | task_complete | 任务完成 |
> | newplayer_guide | 新手指引 |
> | mail | 邮件操作 |
> | item_get 属性名 |
EVENT 属性对应关系
> | coin_get 属性名 |
> | --------------- |
> | 道具ID |
> | 道具类型 |
> | 道具产出途径 |
> | 变动前数量 |
> | 变动数量|
> | 变动后数量|
> | item_cost 属性名 |
> | 货币 ID |
> | 货币产出途径 |
> | 变动前数量 |
> | 变动数量 |
> | 变动后数量 |
> | coin_cost 属性名 |
> | ---------------- |
> | 货币 ID |
> | 货币消耗途径 |
> | 变动前数量 |
> | 变动数量 |
> | 变动后数量 |
> | item_get 属性名 |
> | --------------- |
> | 道具ID |
> | 道具类型 |
> | 道具消耗途径 |
> | 变动前数量 |
> | 变动数量|
> | 变动后数量|
> | 道具 ID |
> | 道具类型 |
> | 道具产出途径 |
> | 变动前数量 |
> | 变动数量 |
> | 变动后数量 |
> | item_cost 属性名 |
> | ---------------- |
> | 道具 ID |
> | 道具类型 |
> | 道具消耗途径 |
> | 变动前数量 |
> | 变动数量 |
> | 变动后数量 |
> | shop 属性名 |
> | --------------- |
> | 商城ID |
> | 购买道具ID |
> | ------------ |
> | 商城 ID |
> | 购买道具 ID |
> | 购买道具数量 |
> | 消耗货币ID |
> | 单价|
> | 消耗货币数量|
> | 消耗货币 ID |
> | 单价 |
> | 消耗货币数量 |
> | task_complete 属性名 |
> | --------------- |
> | 任务ID |
> | 任务类型 |
> | 任务奖励 |
> | task_complete 属性名 |
> | -------------------- |
> | 任务 ID |
> | 任务类型 |
> | 任务奖励 |
> | newplayer_guide 属性名 |
> | --------------- |
> | 步骤ID |
> | newplayer_guide 属性名 |
> | ---------------------- |
> | 步骤 ID |
> | mail 属性名 |
> | --------------- |
> | ------------ |
> | 邮件操作类型 |
> | 邮件ID |
> | 邮件类型 |
> | 邮件标题 |
> | 邮件附件 |
> | 邮件 ID |
> | 邮件类型 |
> | 邮件标题 |
> | 邮件附件 |
> | 邮件到期时间 |
Markdown 格式
0% 或
您添加了 0 人 到此讨论。请谨慎行事。
请先完成此评论的编辑！
请 注册 或者 后发表评论