Skip to content

Z
zw_game_sdk
提交 adcdf1f0 作者: 吴海斌
操作

feat: 转端新增接口

上级 eab37568
正在显示 包含 153 行增加 和 17 行删除
dySdk.js
This source diff could not be displayed because it is too large. You can view the blob instead.
抖音SDK对接说明.md
# 游戏 SDK 对接文档-v1.0.1 # 游戏 SDK 对接文档-v1.0.1
...@@ -225,6 +225,26 @@ ...@@ -225,6 +225,26 @@
        返回参数         返回参数
        示例         示例
    3.17 [SDK 是否展示转端引导](#sec3.17)
        调用方式
        返回参数
        返回数据样例
        示例
    3.18 [SDK 抖小带端关键行为事件上报](#sec3.18)
        调用方式
        请求参数
        返回参数
        返回数据样例
        示例
## 1. 接入说明<a name="sec1"></a> ## 1. 接入说明<a name="sec1"></a>
...@@ -620,7 +640,7 @@ zwsdk.getGameConf() ...@@ -620,7 +640,7 @@ zwsdk.getGameConf()
> | 参数 | 类型 | 说明 | > | 参数 | 类型 | 说明 |
> | :-------------------------------------------------------------------------------------------------------------- | :----- | :------------------------------------- | > | :-------------------------------------------------------------------------------------------------------------- | :----- | :------------------------------------- |
> | status_code | Int | 返回状态 | > | status_code | Int | 返回状态 |
> | msg | String | 返回信息 | > | msg | String | 返回信息 |
> | data | Object | 用户数据 | > | data | Object | 用户数据 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;data | Object | 用户数据 | > | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;data | Object | 用户数据 |
...@@ -670,7 +690,7 @@ zwsdk.login(config:Object) ...@@ -670,7 +690,7 @@ zwsdk.login(config:Object)
> | 参数 | 类型 | 说明 | > | 参数 | 类型 | 说明 |
> | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----- | :----------------------------------------------------------- | > | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----- | :----------------------------------------------------------- |
> | status_code | Int | 返回状态 | > | status_code | Int | 返回状态 |
> | msg | String | 返回信息 | > | msg | String | 返回信息 |
> | data | Object | 用户数据 | > | data | Object | 用户数据 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;data | Object | 用户数据 | > | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;data | Object | 用户数据 |
...@@ -680,10 +700,11 @@ zwsdk.login(config:Object) ...@@ -680,10 +700,11 @@ zwsdk.login(config:Object)
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;user_token | String | TOKEN | > | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;user_token | String | TOKEN |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;isAduser | String | 是否通过广告带来的用户 1 是 0 否 | > | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;isAduser | String | 是否通过广告带来的用户 1 是 0 否 |
> | &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;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;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;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,玩家唯一标识请勿用错, 通过分享进入才有该字段 | > | &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,玩家唯一标识请勿用错, 通过分享进入才有该字段 |
> | is_vip | Int | 是否付费 1: 付费 2: 没有付费 |
##### 示例 ##### 示例
...@@ -801,7 +822,6 @@ zwsdk.createOrder(config:Object) ...@@ -801,7 +822,6 @@ zwsdk.createOrder(config:Object)
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;data | Object | 用户数据 | > | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;data | Object | 用户数据 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;order_id | String | 订单 ID | > | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;order_id | String | 订单 ID |
##### 示例 ##### 示例
```javascript ```javascript
...@@ -1352,13 +1372,13 @@ zwsdk.awemePay(config:Object) ...@@ -1352,13 +1372,13 @@ zwsdk.awemePay(config:Object)
##### 请求参数 ##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 | > | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------ | :---- | :------ | :----- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | > | :----------- | :--- | :----- | :----- | :----------------------------------------------------------------------------------------------------------------- |
> | buyQuantity | true | Number | 100 | 游戏币购买数量。游戏币数量必须满足：游戏币数量*游戏币单价 = 限定价格等级; | > | buyQuantity | true | Number | 100 | 游戏币购买数量。游戏币数量必须满足：游戏币数量\*游戏币单价 = 限定价格等级; |
> | customId | true | String | - | 游戏开发者自定义的唯一订单号，订单支付成功后通过服务端支付结果回调回传; | > | customId | true | String | - | 游戏开发者自定义的唯一订单号，订单支付成功后通过服务端支付结果回调回传; |
> | currencyType| true | String | - | 币种，目前仅为“DIAMOND”; | > | currencyType | true | String | - | 币种，目前仅为“DIAMOND”; |
> | zoneId | true | String | ’1‘ | 游戏服务区 id，开发者自定义; | > | zoneId | true | String | ’1‘ | 游戏服务区 id，开发者自定义; |
> | extraInfo | true | String | - | 游戏开发者自定义的其他信息，订单支付成功后通过服务端支付结果回调回传。字符串长度最大不能超过 256。（强烈建议传入） | > | extraInfo | true | String | - | 游戏开发者自定义的其他信息，订单支付成功后通过服务端支付结果回调回传。字符串长度最大不能超过 256。（强烈建议传入） |
##### 返回参数 ##### 返回参数
...@@ -1394,7 +1414,8 @@ zwsdk ...@@ -1394,7 +1414,8 @@ zwsdk
// res.status 返回状态 // res.status 返回状态
// res.msg 返回信息 // res.msg 返回信息
// res.msg 返回数据 // res.msg 返回数据
}).catch((err) => { })
.catch((err) => {
// ....... // .......
// res.status 返回状态 // res.status 返回状态
// res.msg 返回信息 // res.msg 返回信息
...@@ -1421,9 +1442,125 @@ zwsdk.openCustomerService() ...@@ -1421,9 +1442,125 @@ zwsdk.openCustomerService()
```javascript ```javascript
zwsdk zwsdk
.openCustomerService() .openCustomerService()
.then((res) => {})
.catch((err) => {})
```
### 3.17 是否展示转端引导<a name="sec3.17"></a>
---
##### 接口说明
> **\***获取转端引导是否展示
##### 调用方式
```javascript
zwsdk.shouldShowRedirectGuide()
```
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :---------- | :----- | :------------------------------------- |
> | status_code | Int | 返回状态 |
> | msg | String | 返回信息 |
> | data | Object | 返回数据 |
> | show_guide | Int | 转端引导是否显示（1：显示，2：不显示） |
##### 返回数据样例
```javascript
{
"status_code": 1,
"msg": "操作成功",
"data": {
"data": {
"show_guide": 1
}
},
"extra": {}
}
```
##### sdk 调用示例
```javascript
zwsdk
.shouldShowRedirectGuide()
.then((res) => { .then((res) => {
// .......
// res.status 返回状态
// res.msg 返回信息
// res.data.data 返回数据
})
.catch((err) => {})
```
### 3.18 SDK 抖小带端关键行为事件上报<a name="sec3.18"></a>
---
##### 接口说明
> **\***按钮接口调用，返回 Promise 对象
##### 调用方式
```javascript
zwsdk.microgameEvent(config: Object)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :---- | :--- | :----- | :----- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
> | event | true | String | - | event 传值：<br />抖小带端\_转端弹窗展示：microgame_popup_show <br />抖小带端\_转端弹窗点击：microgame_popup_click <br />抖小带端\_固定入口展示：microgame_window_show <br />抖小带端\_固定入口点击：microgame_window_click |
> 调用时机说明:
>
> 1. 抖小带端\_转端弹窗展示
> 调用 zwsdk.microgameEvent({ event: 'microgame_popup_show' })
>
> 2. 抖小带端\_转端弹窗点击
>
> 调用 zwsdk.microgameEvent({ event: 'microgame_popup_click' })
>
> 3. 抖小带端\_固定入口展示
> 调用 zwsdk.microgameEvent({ event: 'microgame_window_show' })
>
> 4. 抖小带端\_固定入口点击
> 调用 zwsdk.microgameEvent({ event: 'microgame_window_click' })
}).catch((err) => { ##### 返回参数
> | 参数 | 类型 | 说明 |
> | :---------- | :----- | :------- |
> | status_code | Int | 返回状态 |
> | msg | String | 返回信息 |
##### 返回数据样例
```javascript
{
"status_code": 1,
"msg": "操作成功",
"extra": {}
}
```
##### sdk 调用示例
```javascript
zwsdk
.microgameEvent({
event: 'microgame_popup_show'
}) })
``` .then((res) => {
\ No newline at end of file // .......
// res.status 返回状态
// res.msg 返回信息
})
.catch((err) => {})
```
Markdown 格式
0% 或
您添加了 0 人 到此讨论。请谨慎行事。
请先完成此评论的编辑！
请 注册 或者 后发表评论