Skip to content

Z
zw_game_sdk
提交 afea4629 作者: 李泽奇
操作

钻石支付隐藏

上级 ac130ccc
正在显示 包含 18 行增加 和 566 行删除
抖音SDK对接说明.md
# 游戏 SDK 对接文档-v1.3.4
# 游戏 SDK 对接文档-v1.0.1
# 游戏 SDK 对接文档-v1.3.4
# 游戏 SDK 对接文档-v1.0.1
### 目录
......@@ -216,100 +216,16 @@
        示例 -->
    3.16 [SDK 打开抖音客服](#sec3.16)
    3.16 [SDK 打开抖音客服平台](#sec3.16)
        示例
        请求参数
        返回数据样例
        返回参数
        示例
    3.17 [SDK 是否展示转端引导](#sec3.17)
        调用方式
        返回参数
        返回数据样例
        示例
    3.18 [SDK 抖小带端关键行为事件上报](#sec3.18)
        调用方式
        请求参数
        返回参数
        返回数据样例
        示例
    3.19 [SDK 推荐流直出查询用户订阅情况](#sec3.19)
        调用方式
        请求参数
        返回参数
        返回数据样例
        示例
    3.20 [SDK 推荐流直出订阅](#sec3.20)
        调用方式
        请求参数
        返回参数
        返回数据样例
        示例
    3.21 [SDK 推荐流直出获取启动信息](#sec3.21)
        调用方式
        返回参数
        返回数据样例
        示例
    3.22 [SDK 推荐流直出上报加载完成时机](#sec3.22)
        调用方式
        请求参数
        返回参数
        返回数据样例
        示例
    3.23 [SDK 角色行为上报](#sec3.23)
        接口说明
        调用方式
        请求参数
        返回参数
        示例
        参数枚举
## 1. 接入说明<a name="sec1"></a>
### 1.1 术语表<a name="sec1.1"></a>
......@@ -764,11 +680,10 @@ 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;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;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;&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,玩家唯一标识请勿用错, 通过分享进入才有该字段 |
> | is_vip | Int | 是否付费 1: 付费 2: 没有付费 |
##### 示例
......@@ -829,7 +744,7 @@ zwsdk.updateUserInfo(config:Object)
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;has_identify | String | 是否实名 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;user_token | String | TOKEN |
<!-- ### 3.5 SDK 下单<a name="sec3.5"></a>
### 3.5 SDK 下单<a name="sec3.5"></a>
---
......@@ -862,7 +777,6 @@ zwsdk.createOrder(config:Object)
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;product_name | true | String | - | 商品名称 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;product_desc | true | String | - | 商品描述 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ext | true | String | "" | CP 自定义扩展字段，透传信息 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;pay_type | false | String | "" | 支付场景: 道具直购场景: tiktok_direct_pay 其余场景不传 |
> | role | true | Object | - | 角色相关 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;event | true | String | - | 充值上传的角色信息 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;server_id | true | String | "" | 游戏服务器 ID |
......@@ -886,6 +800,7 @@ zwsdk.createOrder(config: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 |
##### 示例
```javascript
......@@ -899,8 +814,7 @@ zwsdk
product_cnt: '1',
product_name: '金币',
product_desc: '金币',
ext: '',
pay_type: 'tiktok_direct_pay'
ext: ''
},
role: {
event: '',
......@@ -918,7 +832,7 @@ zwsdk
// res.msg 返回信息
// res.data.data 返回数据
})
``` -->
```
### 3.6 SDK 查询支付结果<a name="sec3.6"></a>
......@@ -1420,7 +1334,7 @@ zwsdk
})
```
### 3.15 SDK 钻石支付<a name="sec3.15"></a>
<!-- ### 3.15 SDK 钻石支付<a name="sec3.15"></a>
---
......@@ -1437,10 +1351,10 @@ zwsdk.awemePay(config:Object)
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :----------- | :--- | :----- | :----- | :----------------------------------------------------------------------------------------------------------------- |
> | buyQuantity | true | Number | 100 | 游戏币购买数量。游戏币数量必须满足：游戏币数量\*游戏币单价 = 限定价格等级; |
> | :------------ | :---- | :------ | :----- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
> | buyQuantity | true | Number | 100 | 游戏币购买数量。游戏币数量必须满足：游戏币数量*游戏币单价 = 限定价格等级; |
> | customId | true | String | - | 游戏开发者自定义的唯一订单号，订单支付成功后通过服务端支付结果回调回传; |
> | currencyType | true | String | - | 币种，目前仅为“DIAMOND”; |
> | currencyType| true | String | - | 币种，目前仅为“DIAMOND”; |
> | zoneId | true | String | ’1‘ | 游戏服务区 id，开发者自定义; |
> | extraInfo | true | String | - | 游戏开发者自定义的其他信息，订单支付成功后通过服务端支付结果回调回传。字符串长度最大不能超过 256。（强烈建议传入） |
......@@ -1478,98 +1392,15 @@ zwsdk
// res.status 返回状态
// res.msg 返回信息
// res.msg 返回数据
})
.catch((err) => {
}).catch((err) => {
// .......
// res.status 返回状态
// res.msg 返回信息
// res.msg 返回数据
})
```
### 3.16 SDK 打开抖音客服<a name="sec3.16"></a>
---
##### 接口说明
> **\***按钮接口调用，返回 Promise 对象
##### 调用方式
```javascript
zwsdk.openCustomerService(config: Object)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :--- | :--- | :----- | :----- | :------------------------------- |
> | type | true | Number | 3 | 2 : 抖音 IM 客服 3：抖音客服平台 |
##### sdk 调用示例
```javascript
zwsdk
.openCustomerService({ type: 3 })
.then((res) => {})
.catch((err) => {})
```
### 3.17 是否展示转端引导<a name="sec3.17"></a>
---
##### 接口说明
> **\***获取转端引导是否展示
##### 调用方式
```javascript
zwsdk.shouldShowRedirectGuide()
```
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :--------------------------------------------------------------------------------------------------------- | :----- | :------------------------------------- |
> | status_code | Int | 返回状态 |
> | msg | String | 返回信息 |
> | 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;show_guide | Int | 转端引导是否显示（1：显示，2：不显示） |
##### 返回数据样例
```javascript
{
"status_code": 1,
"msg": "操作成功",
"data": {
"data": {
"show_guide": 1
}
},
"extra": {}
}
```
##### sdk 调用示例
```javascript
zwsdk
.shouldShowRedirectGuide()
.then((res) => {
// .......
// res.status 返回状态
// res.msg 返回信息
// res.data.data 返回数据
})
.catch((err) => {})
```
``` -->
### 3.18 SDK 抖小带端关键行为事件上报<a name="sec3.18"></a>
### 3.16 SDK 打开抖音客服平台<a name="sec3.16"></a>
---
......@@ -1580,395 +1411,17 @@ zwsdk
##### 调用方式
```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' })
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :---------- | :----- | :------- |
> | status_code | Int | 返回状态 |
> | msg | String | 返回信息 |
##### 返回数据样例
```javascript
{
"status_code": 1,
"msg": "操作成功",
"extra": {}
}
```
##### sdk 调用示例
```javascript
zwsdk
.microgameEvent({
event: 'microgame_popup_show'
})
.then((res) => {
// .......
// res.status 返回状态
// res.msg 返回信息
})
.catch((err) => {})
```
### 3.19 推荐流直出查询用户订阅情况<a name="sec3.19"></a>
---
##### 接口说明
> **\***查询用户直玩订阅的授权情况，返回 Promise 对象
##### 调用方式
```javascript
zwsdk.checkFeedSubscribeStatus(config:Object)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :---- | :--- | :----- | :----- | :---------------------------------------------------- |
> | scene | true | Number | 1 | 场景类型 1.离线收益场景 2.体力恢复场景 3.重要事件掉落 |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :----------------------------------------------------------------------------------------------------- | :------ | :-------------------------------------------------- |
> | status_code | Int | 返回状态 |
> | msg | String | 返回信息 |
> | 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;status | Boolean | 用户的订阅状态（true 为已经订阅，false 为用户未订阅 |
##### 返回数据样例
```javascript
{
"status_code": 1,
"msg": "操作成功",
"data": {
"data": {
"status": true
}
},
"extra": {}
}
zwsdk.openCustomerService()
```
##### sdk 调用示例
```javascript
zwsdk
.checkFeedSubscribeStatus({ scene: 1 })
.openCustomerService()
.then((res) => {
// .......
// res.status 返回状态
// res.msg 返回信息
// res.data.data 返回数据
})
.catch((err) => {})
```
### 3.20 推荐流直出订阅<a name="sec3.20"></a>
---
##### 接口说明
> **\***向用户请求授权，允许游戏在满足一定的条件后出现在 Feed 流中，返回 Promise 对象
##### 调用方式
```javascript
zwsdk.requestFeedSubscribe(config:Object)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :---- | :--- | :----- | :----- | :---------------------------------------------------- |
> | scene | true | Number | 1 | 场景类型 1.离线收益场景 2.体力恢复场景 3.重要事件掉落 |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :------------------------------------------------------------------------------------------------------ | :------ | :---------------------------------------------- |
> | status_code | Int | 返回状态 |
> | msg | String | 返回信息 |
> | 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;success | Boolean | 用户的订阅结果（true 为成功，false 为订阅失败） |
##### 返回数据样例
}).catch((err) => {
```javascript
{
"status_code": 1,
"msg": "订阅成功",
"data": {
"data": {
"success": true
}
},
"extra": {}
}
```
##### sdk 调用示例
```javascript
zwsdk
.requestFeedSubscribe({ scene: 1 })
.then((res) => {
// .......
// res.status 返回状态
// res.msg 返回信息
// res.data.data 返回数据
})
.catch((err) => {})
```
\ No newline at end of file
### 3.21 推荐流直出获取启动信息<a name="sec3.21"></a>
---
##### 接口说明
> **\***获取具体的启动场景和自定义的游戏信息字段，返回小游戏启动参数
##### 调用方式
```javascript
zwsdk.getLaunchOptionsSync()
```
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :-------------------------------------------------------------- | :----- | :-------------------------------------------------------------------------- |
> | scene | String | 固定为：xx3041，标识推荐流直出场景（xx 表示为可变的数字，只需要判断后四位） |
> | query | Object | 返回信息 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;feed_game_scene | number | 1：离线收益场景，2：体力恢复场景，3：重要事件掉落 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;feed_game_extra | string | 自定义 |
##### 返回数据样例
```javascript
{
"scene": "xx3041",
"query": {
"feed_game_scene": 1,
"feed_game_extra": "",
},
}
```
##### sdk 调用示例
```javascript
const launchOptions = zwsdk.getLaunchOptionsSync()
console.log(launchOptions)
```
### 3.22 推荐流直出上报加载完成时机<a name="sec3.22"></a>
---
##### 接口说明
> **\***向平台侧传达游戏场景加载完成、达到可交互状态的时机，同时也便于开发者进行场景加载耗时统计和分析，返回 Promise 对象
##### 调用方式
```javascript
zwsdk.reportScene(config:Object)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------- | :---- | :----- | :----- | :---------------- |
> | costTime | false | Number | 0 | 场景耗时，单位 ms |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :---------- | :----- | :------- |
> | status_code | Int | 返回状态 |
> | msg | String | 返回信息 |
##### 返回数据样例
```javascript
{
"status_code": 1,
"msg": "上报成功",
}
```
##### sdk 调用示例
```javascript
zwsdk
.reportScene({})
.then((res) => {
// .......
// res.status 返回状态
// res.msg 返回信息
})
.catch((err) => {})
```
### 3.23 SDK 角色行为上报<a name="sec3.23"></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 |
> | 邮件类型 |
> | 邮件标题 |
> | 邮件附件 |
> | 邮件到期时间 |
Markdown 格式
0% 或
您添加了 0 人 到此讨论。请谨慎行事。
请先完成此评论的编辑！
请 注册 或者 后发表评论