Skip to content

Z
zw_game_sdk
提交 12cd09f6 作者: Administrator
操作

合并分支 'release' 到 'master' 

Release: 新增种花论坛跳转

查看合并请求 zwwl/zw_game_sdk!269
上级 517bf57a 4e6864eb
正在显示 包含 113 行增加 和 75 行删除
SDK对接说明.md
# 游戏 SDK 对接文档-v1.3.0
# 游戏 SDK 对接文档-v1.3.0
......@@ -254,6 +254,18 @@
        示例
    3.19 [SDK 种花论坛小程序跳转（种花游戏专用）](#sec3.19)
        接口说明
        调用方式
        请求参数
        返回参数
        示例
## 1. 接入说明<a name="sec1"></a>
### 1.1 术语表<a name="sec1.1"></a>
......@@ -1537,58 +1549,58 @@ EVENT 属性对应关系
> | 邮件附件 |
> | 邮件到期时间 |
熊猫大作战 EVENT 枚举
熊猫大作战 EVENT 枚举
> | EVENT | 说明 |
> | ----------------------------- | ------------- |
> | promotion_complete | 晋升完成 |
> | follower_start_up | 随从星级升级 |
> | bounty_accept_task_num | 悬赏接取任务数 |
> | bounty_refresh_task_num | 悬赏刷新任务数 |
> | arena_points_inc | 竞技场积分提升 |
> | item_get | 道具产出 |
> | item_cost | 道具消耗 |
> | shop | 商城购买 |
熊猫大作战 EVENT 属性对应关系
> | follower_start_up 属性名 |
> | ------------ |
> | 随从等级 |
> | EVENT | 说明 |
> | ----------------------- | -------------- |
> | promotion_complete | 晋升完成 |
> | follower_start_up | 随从星级升级 |
> | bounty_accept_task_num | 悬赏接取任务数 |
> | bounty_refresh_task_num | 悬赏刷新任务数 |
> | arena_points_inc | 竞技场积分提升 |
> | item_get | 道具产出 |
> | item_cost | 道具消耗 |
> | shop | 商城购买 |
> | bounty_accept_task_num 属性名 |
> | ------------ |
> | 任务数量 |
熊猫大作战 EVENT 属性对应关系
> | bounty_refresh_task_num 属性名 |
> | ------------ |
> | 任务数量 |
> | follower_start_up 属性名 |
> | ------------------------ |
> | 随从等级 |
> | arena_points_inc 属性名 |
> | ------------ |
> | 竞技场提升积分 |
> | 竞技场积分 |
> | bounty_accept_task_num 属性名 |
> | ----------------------------- |
> | 任务数量 |
> | item_get 属性名 |
> | ------------ |
> | 道具ID |
> | 道具产出途径 |
> | 变动前数量 |
> | 变动数量 |
> | 变动后数量 |
> | bounty_refresh_task_num 属性名 |
> | ------------------------------ |
> | 任务数量 |
> | item_cost 属性名 |
> | ------------ |
> | 道具ID |
> | 道具产出途径 |
> | 变动前数量 |
> | 变动数量 |
> | 变动后数量 |
> | arena_points_inc 属性名 |
> | ----------------------- |
> | 竞技场提升积分 |
> | 竞技场积分 |
> | shop 属性名 |
> | ------------ |
> | 礼包名称 |
> | 礼包金额 |
> | item_get 属性名 |
> | --------------- |
> | 道具ID |
> | 道具产出途径 |
> | 变动前数量 |
> | 变动数量 |
> | 变动后数量 |
> | item_cost 属性名 |
> | ---------------- |
> | 道具ID |
> | 道具产出途径 |
> | 变动前数量 |
> | 变动数量 |
> | 变动后数量 |
> | shop 属性名 |
> | ----------- |
> | 礼包名称 |
> | 礼包金额 |
### 3.17 SDK 广告行为上报<a name="sec3.17"></a>
......@@ -1726,48 +1738,42 @@ zwsdk
.catch((err) => {})
```
### 3.19 种花道具 H5 领取链接接口（种花游戏专用）<a name="sec3.18"></a>
### 3.19 种花论坛小程序跳转（种花游戏专用）<a name="sec3.19"></a>
---
##### 接口说明
> **\***种花游戏使用鲜花道具时使用（注：只有种花游戏接入），返回 Promise 对象
> **\***种花游戏跳转论坛/关联小程序时使用（注：只有种花游戏接入）。SDK 先请求服务端获取目标小程序 `appId` 与 `path`，再调用 [wx.navigateToMiniProgram](https://developers.weixin.qq.com/minigame/dev/api/navigate/wx.navigateToMiniProgram.html) 打开；返回 Promise 对象。
##### 调用方式
```javascript
zwsdk.getFlowerUrl(config:Object)
zwsdk.jumpFlowerForum(config:Object)
```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------ | :--- | :----- | :----- | :------ |
> | prop_id | true | String | '' | 道具 id |
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :----- | :---- | :----- | :----- | :---------------------------------------------------------- |
> | gameId | false | String | '' | 游戏 id，对应接口 `/mini_sdk/game/getJumpData` 的 `game_id` |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :---------- | :----- | :----- | ------ | -------- |
> | status_code | String | | | 返回状态 |
> | msg | String | | | 返回信息 |
> | data | Object | | | 用户数据 |
> | | data | Object | | 用户数据 |
> | | | url | String | 游戏链接 |
> 与 SDK 内部请求 `/mini_sdk/game/getJumpData` 的响应一致；成功时 `resolve` 传入该响应对象。跳转失败或请求失败时 `reject`。
##### 返回数据样例
> 以下为服务端接口常见数据结构示意（以实际联调为准）；`data.app_id`、`data.path` 会用于 `wx.navigateToMiniProgram`。
```javascript
{
"status_code": 1,
"msg": "获取成功",
"msg": "操作成功",
"data": {
"data": {
"url": "http://landingdev.zwwlkj03.top/flowerOrder/index.html?dev=1&pd=LJvH8NHKFH7Jrn0MFKLFt5bHKgVo20Y7J7fHPMl-6Xg%3D&t=2&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ6c2FwaS56d3dsa2owMy50b3AiLCJhdWQiOiJ6c2FwaS56d3dsa2owMy50b3AiLCJpYXQiOjE3Njg0NzY4MjMsImRhdGEiOnsiaWQiOiIzNjI1OTg3MDUiLCJnYW1lX2lkIjoiNDYiLCJwbGF5ZXJfaWQiOiIzMjMzODIyODIifX0.ozbB8UHLtjwBsERIJDArS_zzj233QZNcwcqLplFG9-U#46"
}
},
"extra": {}
"app_id": "目标小程序 appId",
"path": "pages/index/index"
}
}
```
......@@ -1775,16 +1781,13 @@ zwsdk.getFlowerUrl(config:Object)
```javascript
zwsdk
.getFlowerUrl({
prop_id: '123'
.jumpFlowerForum({
gameId: 'your_game_id'
})
.then((res) => {
// .......
// res.status 返回状态
// res.msg 返回信息
// res.data.data: {
// "url": "http://landingdev.zwwlkj03.top/flowerOrder/index.html?dev=1&pd=LJvH8NHKFH7Jrn0MFKLFt5bHKgVo20Y7J7fHPMl-6Xg%3D&t=2&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ6c2FwaS56d3dsa2owMy50b3AiLCJhdWQiOiJ6c2FwaS56d3dsa2owMy50b3AiLCJpYXQiOjE3Njg0NzY4MjMsImRhdGEiOnsiaWQiOiIzNjI1OTg3MDUiLCJnYW1lX2lkIjoiNDYiLCJwbGF5ZXJfaWQiOiIzMjMzODIyODIifX0.ozbB8UHLtjwBsERIJDArS_zzj233QZNcwcqLplFG9-U#46"
// }
// res.status_code、res.msg 等以接口实际为准
// 成功后已发起 wx.navigateToMiniProgram
})
.catch((err) => {})
```
UnityTrunckPro_SDK/MiniGameExport/WeChat/minigame/sdk.js
This source diff could not be displayed because it is too large. You can view the blob instead.
iossdk_appstore对接说明文档_含广告分享.md
## ZYouSDK V1.0.0文档接入使用
## ZYouSDK V1.0.0文档接入使用
......@@ -73,7 +73,11 @@
| 参数名 | 说明 |
|:--------| -------------:|
| game_id | 游戏唯一标识，由平台方提供 |
|game_secret|服务端对接时会用到，由平台方提供|
| version | 苹果上线版本号，默认为1，由平台方提供 |
| server_host | 账号主体域名，由平台方提供 |
| universal_link_sign | 分享配置标记，由平台方提供 |
| game_id | 游戏唯一标识，由平台方提供 |
|aliAuthSecretKey|服务端对接时会用到，由平台方提供|
> **内购说明**:
支持内购cp方需要提供内购的商品列表
......@@ -112,7 +116,8 @@
QuartzCore
```
&nbsp;&nbsp; 3.4 ZYSDKConfig配置文件中，game_id为平台方提供；server_host为账号主体域名，由平台方提供。其他配置参数请勿修改
&nbsp;&nbsp; 3.4 ZYSDKConfig配置文件中，game_id为平台游戏id，server_host为账号主体域名，universal_link_sign为分享配置标记, aliAuthSecretKey为一键登录key
。都由平台方提供。其他配置参数请勿修改
&nbsp;&nbsp; 3.5 TARGETS点击项目名称，点击 Info 选项卡，添加
> NSUserTrackingUsageDescription权限 配置文案如(是否允许xx使用您的IDFA信息，以此来优化您的使用体验)
......@@ -197,6 +202,30 @@ snssdk1128
universal link生效可能需要版本更新时，苹果才会向服务器请求校验。所以最好确认universal link生效之后再接入分享服务。
&nbsp;&nbsp; 3.12、添加苹果登录支持，在 Signing & Capabilities 中点击 +Capability ，然后选择 Sign in with Apple
得到如下设置
![example3.png](https://zyou-apk.oss-cn-hangzhou.aliyuncs.com/zhangsheng/staging/ios/img/rpAyRY3S5mEjM3m21770626434505.png)
再次点击 +Capability ，然后选择 Keychain Sharing, 在Keychain Groups里新增项目的BundleId
![example3.png](https://zyou-apk.oss-cn-hangzhou.aliyuncs.com/zhangsheng/staging/ios/img/5ccWfS5JTwXhZ4Nb1770626297434.png)
&nbsp;&nbsp; 3.13 TARGETS点击项目名称，点击 Info 选项卡，添加相册权限，具体如下
![example3.png](https://zyou-apk.oss-cn-hangzhou.aliyuncs.com/zhangsheng/production/ios/img/2bDZkcC36G6WhNfc1775186122030.png)
或复制下面文案
```
<key>NSCameraUsageDescription</key>
<string>App的客服聊天功能需要访问您的相机，以便您拍照与客服沟通</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>App的客服聊天功能需要访问您的相册，以便您选择图片与客服沟通</string>
<key>NSPhotoLibraryAddUsageDescription</key>
<string>App的客服聊天功能需要保存图片到您的相册，以便您选择图片与客服沟通</string>
<key>NSMicrophoneUsageDescription</key>
<string>App的客服聊天功能需要访问您的麦克风进行视频，以便您选择视频与客服沟通</string>
```
## 4、初始化SDK<a name="sec4"></a>
......@@ -1026,7 +1055,13 @@ payNotify();
[self toastView:@"上报成功"];
}];
```
### 调用示例<a name="sec11.2"></a>
&nbsp;&nbsp; 获取客服中心链接
```
[[ZYouManager shareInstance] zy_openSdkEvent:@"serviceCenterUrl"];
```
## 服务端接口 调用方直接使用http 调用接口：
......
sdk.js
This source diff could not be displayed because it is too large. You can view the blob instead.
sdk.ts
This source diff could not be displayed because it is too large. You can view the blob instead.
Markdown 格式
0% 或
您添加了 0 人 到此讨论。请谨慎行事。
请先完成此评论的编辑！
请 注册 或者 后发表评论