Skip to content

Z
zw_game_sdk
提交 f4038f36 作者: 赵隆杰
操作

iossdk_appstore对接说明文档更新

上级 2dc5f96f
正在显示 包含 303 行增加 和 82 行删除
iossdk_appstore对接说明文档_含广告分享.md
## ZYouSDK V1.0.0文档接入使用
## ZYouSDK V1.0.0文档接入使用
......@@ -207,7 +207,7 @@ app启动时调用注册sdk ----在AppDelegate 中调用以下方法
//此注册方法需要在游戏初始化之前调用
[[ZYouManager shareInstance]zy_registerGameWithApplication:application options:launchOptions];
// 开启分享服务
[[ZYouManager shareInstance] registerShareUniversalLink:@"your app's universal link"];
[[ZYouManager shareInstance] registerShareUniversalLink:@"https://zmgameios.wozhangwan.com/deepseagarden/share/];
return YES;
}
......@@ -660,108 +660,329 @@ payNotify();
```
## 12、广告<a name="sec11"></a>
### 广告初始化
### 12.1 广告初始化
```
/*
初始化广告
takuAppID
takuAppKey
*/
/// 初始化广告
/// - Parameters:
/// - takuAppID: 在后台的应用ID
/// - takuAppKey: 在后台的应用维度AppKey，或者是账号维度AppKey
- (void)zy_ad_initWithTakuAppID:(NSString *)takuAppID takuAppKey:(NSString *)takuAppKey;
```
### 调用示例<a name="sec11.2"></a>
```
// 研发在广告初始化时调用，可放在游戏加载完成后
[[ZYouManager shareInstance] zy_ad_initWithTakuAppID:@"a6911ace71f10b" takuAppKey:@"a82c177f8a35d09d453487ed9b9980b24"];
[[ZYouManager shareInstance] zy_ad_initWithTakuAppID:@"a6923c90cd8857" takuAppKey:@"a0a8d0c86be83555b7e7ea20e327323f5"];
```
### 预加载广告
### 12.2 全自动加载所有激励广告
```
/*
预加载广告
placementID 广告位ID
scene 场景ID
extra 额外参数
loadBlock(placementID, blockType, loadState, data, error) 回调处理
// 广告的基础代理回调声明，包括广告位与广告源级别的加载成功或失败回调，以及竞价广告源的竞价结束与竞价失败回调
// 一个广告位可以配置多个广告源，因此单次加载操作（load）时，可能会收到多次广告源（ADSource）回调
// 所有广告源加载结束最后也会收到回调，下面用类型区分，下面是回调的参数说明
- placementID 广告位ID
- blockType 回调类型
-- 1 所有广告源加载结束事件回调
-- 2 加载结束后获取展示收益，可用于接收获取信息
-- 3 广告位中某一个广告源加载广告的回调
-- 4 广告位中某一个广告源竞价广告的回调
- loadState 加载回调状态
-- 1 开始加载
-- 2 加载成功
-- 3 加载失败
- data 额外信息字典，无额外信息返回nil
- error 错误信息，无错误返回nil
*/
- (void)zy_adType:(NSString *)adType preLoadAdWithPlacementID:(NSString *)placementID scene:(NSString *)scene extra:(NSDictionary *)extra loadBlock:(void(^)(NSString *placementID, NSString *blockType, NSString *loadState, NSDictionary *data, NSString *error))loadBlock;
- (void)autoLoadAllRewardedAd;
```
### 调用示例<a name="sec11.2"></a>
```
// 广告全自动加载所有，研发调用
[[ZYouManager shareInstance] autoLoadAllRewardedAd];
```
### 12.3 全自动加载多组场景的激励广告
```
/// 全自动加载多组场景的激励广告
/// - Parameters:
/// - RewardedSceneIDs: 场景ID组
- (void)autoLoadRewardedAdRewardedSceneIDs:(NSArray *)RewardedSceneIDs;
```
### 调用示例<a name="sec11.2"></a>
```
// 广告全自动加载多组场景，研发调用
[[ZYouManager shareInstance] autoLoadRewardedAdRewardedSceneIDs:@[@"b1s8", @"b1s9"]];
```
### 12.4 加载激励广告
```
/// 加载激励广告
/// - Parameters:
/// - RewardedPlacementID: 广告位ID
/// - RewardedSceneID: 场景ID，可选，可在后台生成。没有可传入空字符串
/// - extra: 额外信息字典，适用于广告平台的服务端激励验证，将被透传
- (void)loadRewardedAd:(NSString *)RewardedPlacementID RewardedSceneID:(NSString *)RewardedSceneID extra:(NSDictionary *)extra;
```
### 调用示例<a name="sec11.2"></a>
```
// 广告加载，研发调用，第一次广告加载可放在游戏初始化完成后，第二次加载可放在第一次广告显示之后，依次类推
// 加载完成会全部回调，研发若需要回调，一般只需要用加载完成回调，也可不处理回调
NSMutableDictionary * loadConfigDict = [NSMutableDictionary dictionary];
// 可选接入，以下几个key参数适用于广告平台的服务端激励验证，将被透传
[loadConfigDict setValue:@"media_val_RewardedVC" forKey:@"media_val_RewardedVC"];
[loadConfigDict setValue:@"rv_test_user_id" forKey:@"rv_test_user_id"];
[loadConfigDict setValue:@"reward_Name" forKey:@"reward_Name"];
[loadConfigDict setValue:@3 forKey:@"reward_Amount"];
__weak typeof(self) weakSelf = self;
[[ZYouManager shareInstance] zy_adType:@"reward" preLoadAdWithPlacementID:@"b6911ad1b628fa" scene:@"" extra:loadConfigDict loadBlock:^(NSString * _Nonnull placementID, NSString * _Nonnull blockType, NSString * _Nonnull loadState, NSDictionary * _Nonnull data, NSString * _Nonnull error) {
[weakSelf loadBlock:placementID :blockType :loadState :data :error];
}];
[[ZYouManager shareInstance] loadRewardedAd:@"b1gumhqnlglb24" RewardedSceneID:@"" extra:loadConfigDict];
```
### 12.5 显示激励广告
```
- (void)showRewardedAd;
```
### 调用示例<a name="sec11.2"></a>
```
// 广告显示，在研发需要进行广告显示的按钮或图标点击事件中调用
[[ZYouManager shareInstance] showRewardedAd];
```
&nbsp;&nbsp; 广告加载回调处理见demo的loadBlock:
### 展示广告
### 12.6 激励广告回调
```
/*
展示广告
placementID 广告位ID
scene 场景ID
showBlock(placementID, scene, blockType, showState, data, error) 回调处理
//下面是回调的参数说明
- placementID 广告位ID
- scene 场景ID
- blockType 回调类型
-- 1 激励广告视频播放回调
-- 2 激励视频再看一个相关回调
- showState 显示回调状态
-- 1 开始播放
-- 2 播放完毕
-- 3 播放失败
-- 4 已点击
-- 5 激励成功
-- 6 已关闭
-- 7 已打开或跳转深链接页面
- data 额外信息字典，无额外信息返回nil
- error 错误信息，无错误返回nil
- result 结果补充 只有激励广告已关闭和打开跳转深链接页面时才返回，其他情况为nil
返回激励广告已关闭时，已经激励成功result为1，否则为2
返回激励广告打开跳转深链接页面时，打开或跳转成功result为1，否则为2
*/
- (void)zy_adType:(NSString *)adType showAdWithPlacementID:(NSString *)placementID scene:(NSString *)scene showBlock:(void(^)(NSString *placementID, NSString *scene, NSString *blockType, NSString *showState, NSDictionary *data, NSString *error, NSString *result))showBlock;
/// 广告位加载完成
/// - Parameter placementID: 广告位ID
- (void)didFinishLoadingADBlock:(void(^)(NSString *placementID))block;
```
```
/// 广告位加载失败
/// - Parameters:
/// - placementID: 广告位ID
/// - error: 错误信息
- (void)didFailToLoadADBlock:(void(^)(NSString *placementID, NSError *error))block;
```
```
/// 获得展示收益
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
- (void)didRevenueBlock:(void(^)(NSString *placementID, NSDictionary *extra))block;
```
```
/// 激励成功
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
- (void)rewardedVideoDidRewardSuccessBlock:(void(^)(NSString *placementID, NSDictionary *extra))block;
```
```
/// 激励广告视频开始播放
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
- (void)rewardedVideoDidStartPlayingBlock:(void(^)(NSString *placementID, NSDictionary *extra))block;
```
```
/// 激励广告视频播放完毕
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
- (void)rewardedVideoDidEndPlayingBlock:(void(^)(NSString *placementID, NSDictionary *extra))block;
```
```
/// 激励广告视频播放失败
/// - Parameters:
/// - placementID: 广告位ID
/// - error: 错误信息
/// - extra: 额外信息字典
- (void)rewardedVideoDidFailToPlayBlock:(void(^)(NSString *placementID, NSError *error, NSDictionary *extra))block;
```
```
/// 激励广告已关闭
/// - Parameters:
/// - placementID: 广告位ID
/// - rewarded: 是否已经激励成功，YES表示已经回调了激励成功
/// - extra: 额外信息字典
- (void)rewardedVideoDidCloseBlock:(void(^)(NSString *placementID, BOOL rewarded, NSDictionary *extra))block;
```
```
/// 激励广告已点击
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
- (void)rewardedVideoDidClickBlock:(void(^)(NSString *placementID, NSDictionary *extra))block;
```
```
/// 激励广告已打开或跳转深链接页面
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 广告位ID
/// - success: 是否成功
- (void)rewardedVideoDidDeepLinkOrJumpBlock:(void(^)(NSString *placementID, NSDictionary *extra, BOOL result))block;
```
```
/// 激励广告再看一个激励成功
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
- (void)rewardedVideoAgainDidRewardSuccessBlock:(void(^)(NSString *placementID, NSDictionary *extra))block;
```
```
/// 激励广告再看一个视频已开始播放
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
- (void)rewardedVideoAgainDidStartPlayingBlock:(void(^)(NSString *placementID, NSDictionary *extra))block;
```
```
/// 激励广告再看一个视频播放完毕
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
- (void)rewardedVideoAgainDidEndPlayingBlock:(void(^)(NSString *placementID, NSDictionary *extra))block;
```
```
/// 激励广告再看一个视频播放失败
/// - Parameters:
/// - placementID: 广告位ID
/// - error: 错误信息
/// - extra: 额外信息字典
- (void)rewardedVideoAgainDidFailToPlayBlock:(void(^)(NSString *placementID, NSError *error, NSDictionary *extra))block;
```
```
/// 激励广告再看一个已点击
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
- (void)rewardedVideoAgainDidClickBlock:(void(^)(NSString *placementID, NSDictionary *extra))block;
```
### 调用示例<a name="sec11.2"></a>
```
// 广告显示，在研发需要进行广告显示的按钮或图标点击事件中调用
// 所有回调都会透传出来，研发按需取用，一般只需要拿激励广告激励成功的回调
__weak typeof(self) weakSelf = self;
[[ZYouManager shareInstance] zy_adType:@"reward" showAdWithPlacementID:@"b6911ad1b628fa" scene:@"" showBlock:^(NSString * _Nonnull placementID, NSString * _Nonnull scene, NSString * _Nonnull blockType, NSString * _Nonnull showState, NSDictionary * _Nonnull data, NSString * _Nonnull error, NSString * _Nonnull result) {
[weakSelf showBlock:placementID :scene :blockType :showState :data :error :result];
}];
/// 广告位加载完成
/// - Parameter placementID: 广告位ID
[[ZYouManager shareInstance] didFinishLoadingADBlock:^(NSString * _Nonnull placementID) {
NSString *msg = [NSString stringWithFormat:@"广告位%@加载完成", placementID];
[self toastView:msg];
}];
```
```
/// 广告位加载失败
/// - Parameters:
/// - placementID: 广告位ID
/// - error: 错误信息
[[ZYouManager shareInstance] didFailToLoadADBlock:^(NSString * _Nonnull placementID, NSError * _Nonnull error) {
NSString *msg = [NSString stringWithFormat:@"广告位%@加载失败%@", placementID, error.domain];
[self toastView:msg];
}];
```
```
/// 获得展示收益
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
[[ZYouManager shareInstance] didRevenueBlock:^(NSString * _Nonnull placementID, NSDictionary * _Nonnull extra) {
NSString *msg = [NSString stringWithFormat:@"广告位%@获得展示收益", placementID];
[self toastView:msg];
}];
```
```
/// 激励成功
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
[[ZYouManager shareInstance] rewardedVideoDidRewardSuccessBlock:^(NSString * _Nonnull placementID, NSDictionary * _Nonnull extra) {
NSString *msg = [NSString stringWithFormat:@"广告位%@激励成功", placementID];
[self toastView:msg];
}];
```
```
/// 激励广告视频开始播放
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
[[ZYouManager shareInstance] rewardedVideoDidStartPlayingBlock:^(NSString * _Nonnull placementID, NSDictionary * _Nonnull extra) {
NSString *msg = [NSString stringWithFormat:@"广告位%@激励广告视频开始播放", placementID];
[self toastView:msg];
}];
```
```
/// 激励广告视频播放完毕
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
[[ZYouManager shareInstance] rewardedVideoDidEndPlayingBlock:^(NSString * _Nonnull placementID, NSDictionary * _Nonnull extra) {
NSString *msg = [NSString stringWithFormat:@"广告位%@激励广告视频播放完毕", placementID];
[self toastView:msg];
}];
```
```
/// 激励广告视频播放失败
/// - Parameters:
/// - placementID: 广告位ID
/// - error: 错误信息
/// - extra: 额外信息字典
[[ZYouManager shareInstance] rewardedVideoDidFailToPlayBlock:^(NSString * _Nonnull placementID, NSError * _Nonnull error, NSDictionary * _Nonnull extra) {
NSString *msg = [NSString stringWithFormat:@"广告位%@激励广告视频播放失败%@", placementID, error.domain];
[self toastView:msg];
}];
```
```
&nbsp;&nbsp; 广告显示回调处理见demo的showBlock:
/// 激励广告已关闭
/// - Parameters:
/// - placementID: 广告位ID
/// - rewarded: 是否已经激励成功，YES表示已经回调了激励成功
/// - extra: 额外信息字典
[[ZYouManager shareInstance] rewardedVideoDidCloseBlock:^(NSString * _Nonnull placementID, BOOL rewarded, NSDictionary * _Nonnull extra) {
NSString *msg = [NSString stringWithFormat:@"广告位%@激励广告已关闭", placementID];
[self toastView:msg];
}];
```
```
/// 激励广告已点击
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
[[ZYouManager shareInstance] rewardedVideoDidClickBlock:^(NSString * _Nonnull placementID, NSDictionary * _Nonnull extra) {
NSString *msg = [NSString stringWithFormat:@"广告位%@激励广告已点击", placementID];
[self toastView:msg];
}];
```
```
/// 激励广告已打开或跳转深链接页面
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 广告位ID
/// - success: 是否成功
[[ZYouManager shareInstance] rewardedVideoDidDeepLinkOrJumpBlock:^(NSString * _Nonnull placementID, NSDictionary * _Nonnull extra, BOOL result) {
NSString *msg = [NSString stringWithFormat:@"广告位%@激励广告已打开或跳转深链接页面", placementID];
[self toastView:msg];
}];
```
```
/// 激励广告再看一个激励成功
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
[[ZYouManager shareInstance] rewardedVideoAgainDidRewardSuccessBlock:^(NSString * _Nonnull placementID, NSDictionary * _Nonnull extra) {
NSString *msg = [NSString stringWithFormat:@"广告位%@激励广告再看一个激励成功", placementID];
[self toastView:msg];
}];
```
```
/// 激励广告再看一个视频已开始播放
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
[[ZYouManager shareInstance] rewardedVideoAgainDidStartPlayingBlock:^(NSString * _Nonnull placementID, NSDictionary * _Nonnull extra) {
NSString *msg = [NSString stringWithFormat:@"广告位%@激励广告再看一个视频已开始播放", placementID];
[self toastView:msg];
}];
```
```
/// 激励广告再看一个视频播放完毕
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
[[ZYouManager shareInstance] rewardedVideoAgainDidEndPlayingBlock:^(NSString * _Nonnull placementID, NSDictionary * _Nonnull extra) {
NSString *msg = [NSString stringWithFormat:@"广告位%@激励广告再看一个视频播放完毕", placementID];
[self toastView:msg];
}];
```
```
/// 激励广告再看一个视频播放失败
/// - Parameters:
/// - placementID: 广告位ID
/// - error: 错误信息
/// - extra: 额外信息字典
[[ZYouManager shareInstance] rewardedVideoAgainDidFailToPlayBlock:^(NSString * _Nonnull placementID, NSError * _Nonnull error, NSDictionary * _Nonnull extra) {
NSString *msg = [NSString stringWithFormat:@"广告位%@激励广告再看一个视频播放失败%@", placementID, error.domain];
[self toastView:msg];
}];
```
```
/// 激励广告再看一个已点击
/// - Parameters:
/// - placementID: 广告位ID
/// - extra: 额外信息字典
[[ZYouManager shareInstance] rewardedVideoAgainDidClickBlock:^(NSString * _Nonnull placementID, NSDictionary * _Nonnull extra) {
NSString *msg = [NSString stringWithFormat:@"广告位%@激励广告再看一个已点击", placementID];
[self toastView:msg];
}];
```
## 13、透传功能<a name="sec11"></a>
### 透传触发事件
......
overseas/.DS_Store
No preview for this file type
Markdown 格式
0% 或
您添加了 0 人 到此讨论。请谨慎行事。
请先完成此评论的编辑！
请 注册 或者 后发表评论