Skip to content

Z
zw_game_sdk
提交 823f803b 作者: 张梦磊
操作

增加 广告行为上报

上级 54c5fd32
正在显示 包含 101 行增加 和 12 行删除
抖音SDK对接说明.md
# 游戏 SDK 对接文档-v1.0.1
# 游戏 SDK 对接文档-v1.0.1
......@@ -198,6 +198,18 @@
        返回数据样例
    3.14 [SDK 广告行为上报](#sec3.14)
        接口说明
        调用方式
        请求参数
        返回参数
        示例
## 1. 接入说明<a name="sec1"></a>
### 1.1 术语表<a name="sec1.1"></a>
......@@ -641,7 +653,7 @@ zwsdk.login(config:Object)
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :----------------------------------------------------------------------------------------------------------- | :----- | :----------------------------------------------------------- |
> | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----- | :----------------------------------------------------------- |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
> | data | Object | 用户数据 |
......@@ -654,7 +666,7 @@ zwsdk.login(config:Object)
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;h5_url | String | H5 免密登录链接 当为空字符串时不用处理，当有值时需生成转端码 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;is_force | int | 是否强制窗 0:非强制 1:强制，配合 h5_url 一起使用 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;share_data | Object | 分享信息 只有通过分享进入才有值否则值为 [ ] |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;share_player_id | String | 分享人玩家ID, 通过分享进入才有该字段 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;share_player_id | String | 分享人玩家 ID, 通过分享进入才有该字段 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;player_id | String | 玩家 ID,玩家唯一标识请勿用错, 通过分享进入才有该字段 |
##### 示例
......@@ -1147,6 +1159,7 @@ zwsdk.subscribeMessage()
```javascript
zwsdk.subscribeMessage()
```
### 3.13 SDK 分享模板内容到好友<a name="sec3.13"></a>
---
......@@ -1164,21 +1177,24 @@ zwsdk.shareForTemplate(config:Object)
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :-------------- | :---- | :------ | :----- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
> | cp_role_id | true | String | - | 游戏方角色 ID数 |
> | server_id | true | String | - | 区服 ID
> | :--------- | :--- | :----- | :----- | :--------------- |
> | cp_role_id | true | String | - | 游戏方角色 ID 数 |
> | server_id | true | String | - | 区服 ID |
##### 示例
```javascript
zwsdk.shareForTemplate({
zwsdk
.shareForTemplate({
cp_role_id: '123', // 游戏方角色ID
server_id: '1001' // 区服ID
}).then((res) => {
console.log(res);
}).catch((err) => {
console.log(err);
})
})
.then((res) => {
console.log(res)
})
.catch((err) => {
console.log(err)
})
```
##### 返回数据样例
......@@ -1226,3 +1242,76 @@ zwsdk.shareForTemplate({
}
}
```
### 3.14 SDK 广告行为上报<a name="sec3.14"></a>
---
##### 接口说明
> **\***接口返回 Promise 对象
##### 调用方式
```javascript
zwsdk.adReport(config:Object)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------ | :---- | :------ | :----- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
> | event | true | Number | - | 事件 0: 开始 ; 1: 关闭 |
> | type | true | Number | - | 广告类型 1: banner 广告; 2: 激励广告; 3: 插屏广告; |
> | is_over | false | Number | - | 是否完播 0: 否; 1: 是; 激励广告必传 |
> | duration | false | Number | - | 观看时长 单位秒 |
> | showLoading | false | Boolean | false | 异步请求中，是否显示抖音小游戏 loading 提示框 |
> | loadingParams | false | Object | - | showLoading 为 true 时生效。与[抖音小游戏 showLoading](https://developer.open-douyin.com/docs/resource/zh-CN/mini-game/develop/api/interface/interaction/tt-show-loading) 参数一致 |
> | showToast | false | Boolean | false | 异步请求失败，是否显示抖音小游戏消息提示框 <br>异步请求成功，若要显示消息提示，需主动调用抖音小游戏消息提示框框 |
> | toastParams | false | Object | - | showLoading 为 true 时生效。与[抖音小游戏 showToast](https://developer.open-douyin.com/docs/resource/zh-CN/mini-game/develop/api/interface/interaction/tt-show-toast) 参数一致 |
> 调用时机说明:
>
> banner 广告:
> BannerAd.show() 调用
>
> 激励广告:
> RewardedVideoAd.show() 调用
> RewardedVideoAd.onClose() 调用 需要传 是否完播
>
> 插屏广告:
> InterstitialAd.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 人 到此讨论。请谨慎行事。
请先完成此评论的编辑！
请 注册 或者 后发表评论