Skip to content

Z
zw_game_sdk
提交 5f01a432 作者: 吴海斌
操作

feat: 抖音推荐流直出增加sdk接口

上级 4f83e178
正在显示 包含 258 行增加 和 2 行删除
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
...@@ -248,6 +248,52 @@ ...@@ -248,6 +248,52 @@
        示例         示例
    3.19 [SDK 推荐流直出查询用户订阅情况](#sec3.19)
        调用方式
        请求参数
        返回参数
        返回数据样例
        示例
    3.20 [SDK 推荐流直出订阅](#sec3.20)
        调用方式
        请求参数
        返回参数
        返回数据样例
        示例
    3.21 [SDK 推荐流直出获取启动信息](#sec3.21)
        调用方式
        返回参数
        返回数据样例
        示例
    3.22 [SDK 推荐流直出上报加载完成时机](#sec3.22)
        调用方式
        请求参数
        返回参数
        返回数据样例
        示例
## 1. 接入说明<a name="sec1"></a> ## 1. 接入说明<a name="sec1"></a>
### 1.1 术语表<a name="sec1.1"></a> ### 1.1 术语表<a name="sec1.1"></a>
...@@ -1465,7 +1511,7 @@ zwsdk.shouldShowRedirectGuide() ...@@ -1465,7 +1511,7 @@ zwsdk.shouldShowRedirectGuide()
##### 返回参数 ##### 返回参数
> | 参数 | 类型 | 说明 | > | 参数 | 类型 | 说明 |
> | :---------- | :----- | :------------------------------------- | > | :--------------------------------------------------------------------------------------------------------- | :----- | :------------------------------------- |
> | status_code | Int | 返回状态 | > | status_code | Int | 返回状态 |
> | msg | String | 返回信息 | > | msg | String | 返回信息 |
> | data | Object | 返回数据 | > | data | Object | 返回数据 |
...@@ -1567,3 +1613,213 @@ zwsdk ...@@ -1567,3 +1613,213 @@ zwsdk
}) })
.catch((err) => {}) .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": {}
}
```
##### sdk 调用示例
```javascript
zwsdk
.checkFeedSubscribeStatus({ scene: 1 })
.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 为订阅失败） |
##### 返回数据样例
```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) => {})
```
### 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 |
> | scene | true | Number | 1 | 场景类型 1.离线收益场景 2.体力恢复场景 3.重要事件掉落 |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :---------- | :----- | :------- |
> | status_code | Int | 返回状态 |
> | msg | String | 返回信息 |
##### 返回数据样例
```javascript
{
"status_code": 1,
"msg": "上报成功",
}
```
##### sdk 调用示例
```javascript
zwsdk
.reportScene({ scene: 1 })
.then((res) => {
// .......
// res.status 返回状态
// res.msg 返回信息
})
.catch((err) => {})
```
Markdown 格式
0% 或
您添加了 0 人 到此讨论。请谨慎行事。
请先完成此评论的编辑！
请 注册 或者 后发表评论