Skip to content

Z
zw_game_sdk
提交 93576b9c 作者: 李泽奇
操作

Merge branch 'release' of http://git.wozhangwan.com/zwwl/zw_game_sdk into release

上级 16d77f06 978fc3d6
正在显示 包含 262 行增加 和 126 行删除
AI检查敏感词.md
v1.0
v1.0
......@@ -21,23 +21,24 @@ v1.0
请求数据
| 字段 | 是否必传 | 字段类型 | | |
|------------------|------|----------|-----------------------------------------|------|
| zw_app_id | 是 | String | 掌玩appId | |
| cp_role_id | 是 | String | 发言角色ID | |
| action_time | 是 | DateTime | 发送时间 | |
| context | 是 | String | 聊天内容 | |
| context_type | 是 | String | 文本类型，默认为'chat' 聊天 'nick' 昵称 'post' 帖子 | |
| channel_id | 否 | String | 渠道ID | |
| user_id | 否 | String | 用户ID | |
| ip | 否 | String | IP | |
| room_id | 否 | String | 聊天ID | |
| room_name | 否 | String | 聊天室名 | |
| server_id | 否 | String | 区服ID | |
| game_version | 否 | String | 游戏版本号 用于游戏区分不同版本 | |
| receive_id | 否 | String | 消息接受者 私聊场景下聊天对象角色ID | |
| main_game_id | 是 | Int | 主游戏ID | |
| open_server_time | 是 | DateTime | 开服时间 | |
| is_send_diting | 否 | Int | 是否推送谛听，默认为1-是,传参值:1-是,2-否 | |
|------------------|--|----------|-----------------------------------------|------|
| zw_app_id | 是 | String | 掌玩appId | |
| cp_role_id | 是 | String | 发言角色ID | |
| action_time | 是 | DateTime | 发送时间 | |
| context | 是 | String | 聊天内容 | |
| context_type | 是 | String | 文本类型，默认为'chat' 聊天 'nick' 昵称 'post' 帖子 | |
| channel_id | 否 | String | 渠道ID | |
| user_id | 是 | String | 用户ID | |
| ip | 是 | String | IP | |
| room_id | 是 | String | 聊天ID | |
| room_name | 是 | String | 聊天室名 | |
| server_id | 是 | String | 区服ID | |
| game_version | 否 | String | 游戏版本号 用于游戏区分不同版本 | |
| receive_id | 是 | String | 消息接受者 私聊场景下聊天对象角色ID | |
| main_game_id | 是 | Int | 主游戏ID | |
| open_server_time | 是 | DateTime | 开服时间 | |
| is_send_diting | 否 | Int | 是否推送谛听，默认为1-是,传参值:1-是,2-否 | |
| player_id | 是 | Int | 玩家id | |
......
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,65 +1738,35 @@ zwsdk
.catch((err) => {})
```
### 3.19 种花道具 H5 领取链接接口（种花游戏专用）<a name="sec3.18"></a>
### 3.19 种花论坛小程序跳转（种花游戏专用）<a name="sec3.19"></a>
---
##### 接口说明
> **\***种花游戏使用鲜花道具时使用（注：只有种花游戏接入），返回 Promise 对象
> **\***种花游戏跳转论坛/关联小程序时使用（注：只有种花游戏接入）,调用 [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 |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :---------- | :----- | :----- | ------ | -------- |
> | status_code | String | | | 返回状态 |
> | msg | String | | | 返回信息 |
> | data | Object | | | 用户数据 |
> | | data | Object | | 用户数据 |
> | | | url | String | 游戏链接 |
##### 返回数据样例
```javascript
{
"status_code": 1,
"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": {}
}
```
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :----- | :---- | :----- | :----- | :------ |
> | gameId | false | String | '' | 游戏 id |
##### sdk 调用示例
```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"
// }
// 成功后发起 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>
......@@ -676,6 +705,7 @@ payNotify();
```
### 12.2 全自动加载所有激励广告
```
/// 全自动加载所有激励广告
- (void)autoLoadAllRewardedAd;
```
### 调用示例<a name="sec11.2"></a>
......@@ -687,40 +717,55 @@ payNotify();
```
/// 全自动加载多组场景的激励广告
/// - Parameters:
/// - RewardedSceneIDs: 场景ID组
- (void)autoLoadRewardedAdRewardedSceneIDs:(NSArray *)RewardedSceneIDs;
/// - sceneIDs: 场景ID组
- (void)autoLoadRewardedAdSceneIDs:(NSArray *)sceneIDs;
```
### 调用示例<a name="sec11.2"></a>
```
// 广告全自动加载多组场景，研发调用
[[ZYouManager shareInstance] autoLoadRewardedAdRewardedSceneIDs:@[@"b1s8", @"b1s9"]];
[[ZYouManager shareInstance] autoLoadRewardedAdSceneIDs:@[@"b1s8", @"b1s9"]];
```
### 12.4 加载激励广告
### 12.4 预加载激励广告
```
/// 加载激励广告
/// 预加载激励广告
/// - Parameters:
/// - RewardedPlacementID: 广告位ID
/// - RewardedSceneID: 场景ID，可选，可在后台生成。没有可传入空字符串
/// - extra: 额外信息字典，适用于广告平台的服务端激励验证，将被透传
- (void)loadRewardedAd:(NSString *)RewardedPlacementID RewardedSceneID:(NSString *)RewardedSceneID extra:(NSDictionary *)extra;
/// - sceneID: 场景ID
- (void)loadRewardedAdSceneID:(NSString *)sceneID;
```
### 调用示例<a name="sec11.2"></a>
```
// 广告加载，研发调用，第一次广告加载可放在游戏初始化完成后，第二次加载可放在第一次广告显示之后，依次类推
[[ZYouManager shareInstance] loadRewardedAd:@"b1gumhqnlglb24" RewardedSceneID:@"" extra:loadConfigDict];
// 广告预加载，研发调用
[[ZYouManager shareInstance] loadRewardedAdSceneID:@"b1s8"];
```
### 12.5 显示激励广告
```
- (void)showRewardedAd;
/// 显示激励广告（无法展示时通过 didFailToShowADBlock 回调）
/// - Parameters:
/// - sceneID: 场景ID
- (void)showRewardedAdSceneID:(NSString *)sceneID;
```
### 调用示例<a name="sec11.2"></a>
```
// 广告显示，在研发需要进行广告显示的按钮或图标点击事件中调用
[[ZYouManager shareInstance] showRewardedAd];
[[ZYouManager shareInstance] showRewardedAdSceneID:@"b1s8"];
```
说明：
a)在游戏启动后全自动加载，如果已经加载所有场景，后面无需再手动预加载
b)手动预加载目前为可选接入，游戏中需要单独加载某个场景广告，提前预加载传入场景id即可
c)广告显示目前只有一种方法，传入需要显示的场景id即可
### 12.6 激励广告回调
```
/// 全自动加载失败
/// - Parameters:
/// - error: 错误信息
- (void)didFailToAutoLoadADBlock:(void(^)(NSError *error))block;
```
```
/// 广告位加载完成
/// - Parameter placementID: 广告位ID
- (void)didFinishLoadingADBlock:(void(^)(NSString *placementID))block;
......@@ -733,6 +778,13 @@ payNotify();
- (void)didFailToLoadADBlock:(void(^)(NSString *placementID, NSError *error))block;
```
```
/// 广告位显示失败（sceneID 无效、无广告位、未就绪等）
/// - Parameters:
/// - placementID: 广告位ID
/// - error: 错误信息
- (void)didFailToShowADBlock:(void(^)(NSString *placementID, NSError *error))block;
```
```
/// 获得展示收益
/// - Parameters:
/// - placementID: 广告位ID
......@@ -829,6 +881,16 @@ payNotify();
```
### 调用示例<a name="sec11.2"></a>
下面的toastView为Demo展示，实际项目根据自身需求处理
```
/// 全自动加载失败
/// - Parameter error: 错误信息
[[ZYouManager shareInstance] didFailToAutoLoadADBlock:^(NSError * _Nonnull error) {
NSString *msg = [NSString stringWithFormat:@"广告全自动加载失败,%@", error];
[self toastView:msg];
}];
```
```
/// 广告位加载完成
......@@ -849,6 +911,16 @@ payNotify();
}];
```
```
/// 广告位显示失败（sceneID 无效、无广告位、未就绪等）
/// - Parameters:
/// - placementID: 广告位ID
/// - error: 错误信息
[[ZYouManager shareInstance] didFailToShowADBlock:^(NSString * _Nonnull placementID, NSError * _Nonnull error) {
NSString *msg = [NSString stringWithFormat:@"广告展示失败%@ %@", placementID.length ? placementID : @"", error.localizedDescription];
[self toastView:msg];
}];
```
```
/// 获得展示收益
/// - Parameters:
/// - placementID: 广告位ID
......@@ -1026,7 +1098,20 @@ payNotify();
[self toastView:@"上报成功"];
}];
```
### 调用示例<a name="sec11.2"></a>
&nbsp;&nbsp; 获取客服中心链接
```
[[ZYouManager shareInstance] zy_openSdkEvent:@"serviceCenterUrl"];
```
### 调用示例<a name="sec11.2"></a>
&nbsp;&nbsp; 活动站跳转
```
[[ZYouManager shareInstance] zy_openSdkEvent:@"activityStationUrl"];
```
## 服务端接口 调用方直接使用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.
服务端接口.md
# 服务端接口说明
# 服务端接口说明
......@@ -54,6 +54,10 @@
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;3.1.14 [服务端埋点角色批量上报接口](#sec3.1.14)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;3.1.15 [装备日志上报接口](#sec3.1.15)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;3.1.16 [种花主游戏内指定购买指定商品上报](#sec3.1.16)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[签名规则2](#sigin2)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;3.2.1 [AI敏感词聊天记录上报](#sec3.2.1)
......@@ -174,16 +178,17 @@
| context | 是 | String | 聊天内容 | |
| context_type | 是 | String | 文本类型，默认为'chat' 聊天 'nick' 昵称 'post' 帖子 | |
| channel_id | 否 | String | 渠道ID | |
| user_id | 否 | String | 用户ID | |
| ip | 否 | String | IP | |
| room_id | 否 | String | 聊天ID | |
| room_name | 否 | String | 聊天室名 | |
| server_id | 否 | String | 区服ID | |
| user_id | 是 | String | 用户ID | |
| ip | 是 | String | IP | |
| room_id | 是 | String | 聊天ID | |
| room_name | 是 | String | 聊天室名 | |
| server_id | 是 | String | 区服ID | |
| game_version | 否 | String | 游戏版本号 用于游戏区分不同版本 | |
| receive_id | 否 | String | 消息接受者 私聊场景下聊天对象角色ID | |
| receive_id | 是 | String | 消息接受者 私聊场景下聊天对象角色ID | |
| main_game_id | 是 | Int | 主游戏ID | |
| open_server_time | 是 | DateTime | 开服时间 | |
| is_send_diting | 否 | Int | 是否推送谛听，默认为1-是,传参值:1-是,2-否 | |
| player_id | 否 | Int | 玩家id | |
......@@ -637,6 +642,69 @@
| msg | 是 | string | 返回信息 ： 处理成功 |
### 3.1.15 装备日志上报接口<a name="sec3.1.15"></a>
> 接口需要进行签名，签名方法详见[签名规则1](#sigin1)
装备日志上报接口
/server/equipment/equipmentReport
请求数据
| 字段 | 是否必传 | 字段类型 | | |
|-----------------| -------- |----------|--------------------------| ---- |
| zw_app_id | 是 | String | app_id | |
| cp_role_id | 是 | String | cp角色ID | |
| role_name | 是 | String | 角色名称 | |
| server_id | 是 | String | 区服ID | |
| server_name | 是 | String | 区服名称 | |
| cp_account | 是 | String | 用户ID | |
| action_time | 是 | dateTime | 发生时间 2025-03-08 15:00:00 | |
| main_game_id | 是 | int | 主游戏ID | |
| equipment_id | 是 | String | 装备ID | |
| equipment_name | 是 | String | 装备名称 | |
| equipment_level | 是 | int | 装备等级 | |
| equipment_type | 是 | String | 装备类型 | |
返回数据
| | 是否必要 | 字段类型 | |
| ---- | -------- | -------- | --------------------- |
| status_code | 是 | int | 1 成功 2 失败 |
| msg | 是 | string | 返回信息 ： 操作成功 |
### 3.1.16 种花主游戏内指定购买指定商品上报<a name="sec3.1.16"></a>
> 接口需要进行签名，签名方法详见[签名规则1](#sigin1)
接口地址:/server/activity_product/reportLog
请求数据
| 字段 | 是否必传 | 字段类型 | | |
|------------------|------|----------|---------------------------|------|
| zw_app_id | 是 | String | 掌玩appId | |
| cp_role_id | 是 | String | 购买角色ID | |
| player_id | 是 | Int | 玩家id | |
| product_id | 是 | String | 商品id | |
| product_name | 是 | String | 商品名称 | |
| product_cnt | 否 | String | 商品数量 | |
| product_price | 是 | String | 商品价格（分） | |
| pay_time | 是 | String | 支付时间（时间戳） | |
| order_time | 是 | String | 下单时间（时间戳） | |
返回数据
| | 是否必要 | 字段类型 | |
| ---- | -------- | -------- | --------------------- |
| status_code | 是 | int | 1 成功 2 失败 |
| msg | 是 | string | 返回信息 ： 操作成功 |
##### 签名规则2<a name="sigin2"></a>
1. POST 数据结构 JSON
......
Markdown 格式
0% 或
您添加了 0 人 到此讨论。请谨慎行事。
请先完成此评论的编辑！
请 注册 或者 后发表评论