Skip to content

Z
zw_game_sdk
提交 438303f7 作者: 张梦磊
操作

1.10.0 增加广告行为上报

上级 b98aece7
正在显示 包含 136 行增加 和 42 行删除
SDK对接说明.md
# 游戏 SDK 对接文档-v1.1.0 # 游戏 SDK 对接文档-v1.2.0
# 游戏 SDK 对接文档-v1.1.0 # 游戏 SDK 对接文档-v1.2.0
### 目录 ### 目录
...@@ -220,6 +220,18 @@ ...@@ -220,6 +220,18 @@
        参数枚举         参数枚举
    3.16 [SDK 广告行为上报](#sec3.16)
        接口说明
        调用方式
        请求参数
        返回参数
        示例
## 1. 接入说明<a name="sec1"></a> ## 1. 接入说明<a name="sec1"></a>
### 1.1 术语表<a name="sec1.1"></a> ### 1.1 术语表<a name="sec1.1"></a>
...@@ -1329,6 +1341,7 @@ wx.getGameClubData({ ...@@ -1329,6 +1341,7 @@ wx.getGameClubData({
--- ---
##### 接口说明 ##### 接口说明
> 此方法用于上报角色行为，需在角色有对应行为时调用此方法。 > 此方法用于上报角色行为，需在角色有对应行为时调用此方法。
##### 调用方式 ##### 调用方式
...@@ -1340,20 +1353,18 @@ zwsdk.roleEventReport(config:Object) ...@@ -1340,20 +1353,18 @@ zwsdk.roleEventReport(config:Object)
##### 请求参数 ##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 | | > | 参数 | 必选 | 类型 | 默认值 | 说明 | |
> | :------------ | :--- | :----- | :----- | :-------------------------------------------------------------------------------------------------------------------------------------- | --- | > | :---------------------------------------------------- | :--- | :------------------- | :----- | :------------- | --- |
> | role_name | true | String | - | 角色名称 | > | role_name | true | String | - | 角色名称 |
> | cp_role_id | true | String | - | cp角色id | > | cp_role_id | true | String | - | cp 角色 id |
> | event | true | String | - | 事件类型 | > | event | true | String | - | 事件类型 |
> | qureys | true | Array[{name, value}] | - | 属性 | > | qureys | true | Array[{name, value}] | - | 属性 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name | true | String | - | 属性名（中文） | > | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name | true | String | - | 属性名（中文） |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value | true | String | - | 属性值 | > | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value | true | String | - | 属性值 |
##### 返回参数 ##### 返回参数
> | 参数 | 类型 | 说明 | > | 参数 | 类型 | 说明 |
> | :--------------------------------------------------- | :----- | :----------- | > | :---------- | :----- | :--------------------- |
> | status_code | int | 返回状态 1 成功 2 失败 | > | status_code | int | 返回状态 1 成功 2 失败 |
> | msg | String | 返回信息 | > | msg | String | 返回信息 |
...@@ -1361,22 +1372,25 @@ zwsdk.roleEventReport(config:Object) ...@@ -1361,22 +1372,25 @@ zwsdk.roleEventReport(config:Object)
```javascript ```javascript
zwsdk.roleEventReport({ zwsdk.roleEventReport({
role_name: "角色上报测试", role_name: '角色上报测试',
cp_role_id: "111", cp_role_id: '111',
event: "coin_get", event: 'coin_get',
querys: [ querys: [
{"name":"货币id","value":"123"}, { name: '货币id', value: '123' },
{"name":"货币产出途径","value":"掉落"}, { name: '货币产出途径', value: '掉落' },
{"name":"变动前数量", "value":"59"}, { name: '变动前数量', value: '59' },
{"name":"变动数量","value":"32"}, { name: '变动数量', value: '32' },
{"name":"变动后数量","value":"91"} { name: '变动后数量', value: '91' }
] ]
}) })
``` ```
##### 参数枚举 ##### 参数枚举
EVENT枚举
EVENT 枚举
> | EVENT | 说明 | > | EVENT | 说明 |
> | ---------------- | -------- | > | --------------- | -------- |
> | coin_get | 货币产出 | > | coin_get | 货币产出 |
> | coin_cost | 货币消耗 | > | coin_cost | 货币消耗 |
> | item_get | 道具产出 | > | item_get | 道具产出 |
...@@ -1386,65 +1400,145 @@ EVENT枚举 ...@@ -1386,65 +1400,145 @@ EVENT枚举
> | newplayer_guide | 新手指引 | > | newplayer_guide | 新手指引 |
> | mail | 邮件操作 | > | mail | 邮件操作 |
EVENT属性对应关系 EVENT 属性对应关系
> | coin_get 属性名 | > | coin_get 属性名 |
> | --------------- | > | --------------- |
> | 货币ID | > | 货币 ID |
> | 货币产出途径 | > | 货币产出途径 |
> | 变动前数量 | > | 变动前数量 |
> | 变动数量 | > | 变动数量 |
> | 变动后数量 | > | 变动后数量 |
> | coin_cost 属性名 | > | coin_cost 属性名 |
> | --------------- | > | ---------------- |
> | 货币ID | > | 货币 ID |
> | 货币消耗途径 | > | 货币消耗途径 |
> | 变动前数量 | > | 变动前数量 |
> | 变动数量 | > | 变动数量 |
> | 变动后数量| > | 变动后数量 |
> | item_get 属性名 | > | item_get 属性名 |
> | --------------- | > | --------------- |
> | 道具ID | > | 道具 ID |
> | 道具类型 | > | 道具类型 |
> | 道具产出途径 | > | 道具产出途径 |
> | 变动前数量 | > | 变动前数量 |
> | 变动数量| > | 变动数量 |
> | 变动后数量| > | 变动后数量 |
> | item_cost 属性名 | > | item_cost 属性名 |
> | --------------- | > | ---------------- |
> | 道具ID | > | 道具 ID |
> | 道具类型 | > | 道具类型 |
> | 道具消耗途径 | > | 道具消耗途径 |
> | 变动前数量 | > | 变动前数量 |
> | 变动数量| > | 变动数量 |
> | 变动后数量| > | 变动后数量 |
> | shop 属性名 | > | shop 属性名 |
> | --------------- | > | ------------ |
> | 商城ID | > | 商城 ID |
> | 购买道具ID | > | 购买道具 ID |
> | 购买道具数量 | > | 购买道具数量 |
> | 消耗货币ID | > | 消耗货币 ID |
> | 单价| > | 单价 |
> | 消耗货币数量| > | 消耗货币数量 |
> | task_complete 属性名 | > | task_complete 属性名 |
> | --------------- | > | -------------------- |
> | 任务ID | > | 任务 ID |
> | 任务类型 | > | 任务类型 |
> | 任务奖励 | > | 任务奖励 |
> | newplayer_guide 属性名 | > | newplayer_guide 属性名 |
> | --------------- | > | ---------------------- |
> | 步骤ID | > | 步骤 ID |
> | mail 属性名 | > | mail 属性名 |
> | --------------- | > | ------------ |
> | 邮件操作类型 | > | 邮件操作类型 |
> | 邮件ID | > | 邮件 ID |
> | 邮件类型 | > | 邮件类型 |
> | 邮件标题 | > | 邮件标题 |
> | 邮件附件 | > | 邮件附件 |
> | 邮件到期时间 | > | 邮件到期时间 |
### 3.16 SDK 广告行为上报<a name="sec3.16"></a>
---
##### 接口说明
> **\***接口返回 Promise 对象
##### 调用方式
```javascript
zwsdk.adReport(config:Object)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------ | :---- | :------ | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------- |
> | event | true | Number | - | 事件 0: 开始 ; 1: 关闭 |
> | type | true | Number | - | 广告类型 1: banner 广告; 2: 激励广告; 3: 插屏广告; 4: 格子广告; 5: 原生广告 |
> | is_over | false | Number | - | 是否完播 0: 否; 1: 是; 激励广告必传 |
> | duration | false | Number | - | 观看时长 单位秒 |
> | showLoading | false | Boolean | false | 异步请求中，是否显示微信小程序 loading 提示框 |
> | loadingParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showLoading](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showLoading.html) 参数一致 |
> | showToast | false | Boolean | false | 异步请求失败，是否显示微信小程序消息提示框 <br>异步请求成功，若要显示消息提示，需主动调用微信小程序消息提示框框 |
> | toastParams | false | Object | - | showLoading 为 true 时生效。与[微信小程序 showToast](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showToast.html) 参数一致 |
> 调用时机说明:
>
> banner 广告:
> bannerAd.show() 调用
>
> 激励广告:
> rewardedVideoAd.show() 调用
> rewardedVideoAd.onClose() 调用 需要传 是否完播
>
> 插屏广告:
> interstitialAd.show() 调用
>
> 格子广告:
> GridAd.show() 调用
>
> 原生广告:
> customAd.show() 调用
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :---------- | :----- | :------- |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
##### 返回数据样例
```javascript
{
"status_code": 1,
"msg": "操作成功",
"extra": {}
}
```
##### sdk 调用示例
```javascript
zwsdk
.adReport({
event: 1,
type: 2,
is_over: 1,
duration: 30
})
.then((res) => {
// .......
// res.status 返回状态
// res.msg 返回信息
})
```
Markdown 格式
0% 或
您添加了 0 人 到此讨论。请谨慎行事。
请先完成此评论的编辑！
请 注册 或者 后发表评论