趣盟 iOS-SDK 接入文档

使用说明：

建议优先使用 QuMengAdSDK QuMengAdSDK API 前缀使用 "qumeng_" QMAdSDK API 前缀使用 "qm_"

SDK 工程配置及初始化说明

运行环境

xxxxxxxxxx
支持系统 iOS 11.0 及以上

自动部署

注意⚠️：我们建议您使用 CocoaPods 更轻松地管理 Xcode 项目的库依赖项，而不是直接下载并安装 SDK。SDK 的依赖项都在提供的文件中，请注意查收。

xxxxxxxxxx
# 推荐使用（避免缩写冲突）
# 四位版本号 1.3.8 开始支持
# 目前最新版本为：1.5.0.8
pod "QuMengAdSDK", "~> 1.5.0.0"

# 或者使用（即将废弃）
pod "QMAdSDK", "~> 1.5.0.0"

提醒 如果您获取的SDK版本号和推荐版本号不一致，可尝试按照以下骤执行

xxxxxxxxxx
1. 在 podfile 文件中注释 pod "QuMengAdSDK", "~> 1.5.0.0"
  
2. 终端执行 pod install

3. 终端执行 pod cache clean QuMengAdSDK

4. 在podfile文件中打开 pod "QuMengAdSDK", "~> 1.5.0.0"

5. 终端执行 pod install QMAdSDK

手动部署

下载压缩包，将 QuMengAdSDK.xcframework 或者 QMAdSDK.xcframework 添加项目工程中即可完成手动部署。

Xcode 配置

Info.plist 中 添加 Privacy - Tracking Usage Description 权限

xxxxxxxxxx
<key>NSUserTrackingUsageDescription</key>
<string>该ID将用于向您推送个性化广告</string>

Info.plist 中加入

xxxxxxxxxx
<key>LSApplicationQueriesSchemes</key>
<array>
  <string>meituanwaimai</string>
    <string>openapp.jdmobile</string>
    <string>jdmobile</string>
    <string>bilibili</string>
    <string>pddopen</string>
    <string>pinduoduo</string>
    <string>iosamap</string>
    <string>freereader</string>
    <string>iqiyi</string>
    <string>tmall</string>
    <string>vipshop</string>
    <string>alipays</string>
    <string>OneTravel</string>
    <string>eleme</string>
    <string>sinaweibo</string>
    <string>youku</string>
    <string>imeituan</string>
    <string>amapuri</string>
    <string>baiduboxlite</string> 
    <string>bdboxiosqrcode</string> 
    <string>baidumobads</string> 
    <string>kwai</string>
    <string>snssdk1128</string>
    <string>weixinULAPI</string>
    <string>weixinulapi</string>
    <string>weixinURLParamsAPI</string>
    <string>weixin</string>
    <string>ctrip</string>
    <string>taobaotravel</string>
    <string>mqq</string>
    <string>mqqapi</string>
    <string>bytedance</string>
    <string>taobao</string>
    <string>tbopen</string>
    <string>xhsdiscover</string>
    <string>ksnebula</string>
    <string>fleamarket</string>
    <string>tantanapp</string>
    <string>txvideo</string>
    <string>dianping</string>
    <string>mdsopen</string>
    <string>yanxuan</string>
    <string>mdopen</string>
    <string>openanjuke</string>
    <string>lianjia</string>
    <string>soul</string>
</array>

SDK 初始化

注意事项

• QuMengAdSDKConfiguration 是 SDK 配置中心，可以中途修改配置

• QuMengAdSDKManager 是 SDK 的入口和接口中心

• 任意广告类型均不支持中途更改代理，中途更改代理会导致接收不到广告相关回调，如若存在中途更改代理场景，需自行处理相关逻辑，确保广告相关回调正常执行。

接入代码

xxxxxxxxxx
QuMengAdSDKConfiguration *config = [QuMengAdSDKConfiguration shareConfiguration];
config.appId = @"应用ID";
config.customIdfa = @"自定义IDFA";
config.qmcds = @[
  @{@"qmcd": @"", @"version": @""},
  @{@"qmcd": @"", @"version": @""}
];
config.longitude = @"经度";
config.latitude = @"纬度";
// 注意⚠️：是否开启个性化推荐，开启则会获取 IDFA 默认：YES
// 如果开启需要在 Info.plist 中 添加 `Privacy - Tracking Usage Description` 权限
config.isEnablePersonalAds = YES;
// 是否开启 SDK 的播放器配置，版本要求大于等于 1.3.3
// 在播放音频时是否使用 SDK 内部对 AVAudioSession 设置的 category 及 options，默认（YES）使用，若不使用，SDK 内部不做任何处理，由调用方在展示广告时自行设置；
// SDK 默认设置的 category 为 AVAudioSessionCategoryAmbient，options 为 AVAudioSessionCategoryOptionDuckOthers
config.enableDefaultAudioSessionSetting = YES;

// 初始化 SDK
[QuMengAdSDKManager setupSDKWith:config];
// 或：初始化 SDK 并返回状态
[QuMengAdSDKManager setupSDKWith:config completion:^(BOOL success, NSError * _Nonnull error) {
    
}]; 

// 是否允许摇一摇/扭一扭（单设备纬度）默认：YES 允许（1.3.7及以上版本支持）
[QMAdSDKManager setTwistSwitch:YES];

开屏广告

简介

开屏广告使用 QuMengSplashAd 对象管理开屏广告所有业务。开屏广告所有视图的展示和移除将由 SDK 统一管理，开发者无需关心。 接入方式上，使用 QuMengSplashAd 对象调用 loadAdData 方法请求广告，调用 show 方法展示广告，通过设置 QuMengSplashAdDelegate 代理，获取广告加载、渲染、点击、关闭、跳转等回调。

接入代码

广告位对象创建时必须传入广告位ID

xxxxxxxxxx
_splashAd = [[QuMengSplashAd alloc] initWithSlot:slotID];
// 广告点击强制关闭
// _splashAd.adClickToCloseAutomatically = YES
_splashAd.delegate = self;
[_splashAd loadAdData];

广告物料加载成功后，会回调 qumeng_splashAdLoadSuccess 方法，在此处展示开屏广告

xxxxxxxxxx
- (void)qumeng_splashAdLoadSuccess:(QuMengSplashAd *)splashAd {
  // controller window 二选一
  
  // 检查广告有效性（1.3.7及以上版本支持）
  [splashAd isValid];

  // 非自定义bottom view
  [splashAd showSplashViewController:controller];
  
  // 自定义bottom view
  // UILabel *view = [[UILabel alloc] initWithFrame:CGRectMake(160, 35, 200, 30)];
  // view.text = @"欢迎接入趣盟";
  // [splashAd showSplashViewController:controller winthBottomView:view];

  // window 层级弹窗
    // [splashAd showSplashWindow:keyWindow withBottomView:view];
    // window 层级弹窗 自定义bottom view
    // [splashAd showSplashWindow:keyWindow withBottomView:view];   
}

开屏回调说明

插屏广告

简介

插屏广告使用 QuMengInterstitialAd 对象管理插屏广告所有业务。插屏广告所有视图的展示和移除将由 SDK 统一管理，开发者无需关心。 接入方式上，使用 QuMengInterstitialAd 对象调用 loadAdData 方法请求广告，调用 show 方法展示广告，通过设置 QuMengInterstitialAdDelegate 代理，获取广告加载、渲染、点击、关闭、跳转等回调。

接入代码

广告位对象创建时必须传入广告位ID

xxxxxxxxxx
_intertitialAd = [[QuMengInterstitialAd alloc] initWithSlot:slotID];
// 广告点击强制关闭
_intertitialAd.adClickToCloseAutomatically = YES
_intertitialAd.delegate = self;
[_intertitialAd loadAdData];

广告物料加载成功后，会回调 qumeng_interstitialAdLoadSuccess 方法，在此处展示开屏广告

xxxxxxxxxx
- (void)qumeng_interstitialAdLoadSuccess:(QuMengInterstitialAd *)interstitialAd {
  // 检查广告有效性（1.3.7及以上版本支持）
  [interstitialAd isValid];
  [intertitialAd showInterstitialViewInRootViewController:controller];
}

插屏回调说明

激励视频广告

简介

激励视频广告使用 QuMengRewardedVideoAd 对象管理激励视频广告所有业务。激励视频广告所有视图的展示和移除将由 SDK 统一管理，开发者无需关心。 接入方式上，使用 QuMengRewardedVideoAd 对象调用 loadAdData 方法请求广告，调用 show 方法展示广告，通过设置 QuMengRewardedVideoAdDelegate 代理，获取广告加载、渲染、点击、关闭、跳转等回调。

接入代码

广告位对象创建时必须传入广告位ID

xxxxxxxxxx
_rewardedVideoAd = [[QuMengRewardedVideoAd alloc] initWithSlot:slotID];
_rewardedVideoAd.delegate = self;
[_rewardedVideoAd loadAdData];

广告物料加载成功后，会回调 qumeng_rewardedVideoAdLoadSuccess 方法，在此处展示开屏广告

xxxxxxxxxx
- (void)qumeng_rewardedVideoAdLoadSuccess:(QuMengRewardedVideoAd *)rewardedVideoAd {
  // 检查广告有效性（1.3.7及以上版本支持）
  [rewardedVideoAd isValid];
  [rewardedVideoAd showRewardedVideoViewInRootViewController:controller];
}

激励视频回调说明

信息流广告

简介

信息流广告使用 QuMengFeedAd 对象管理信息流广告所有业务。 接入方式上，使用 QuMengFeedAd 对象调用 loadAdData 方法请求广告，调用 show 方法展示广告，通过设置 QuMengFeedAdDelegate 代理，获取广告加载、渲染、点击、关闭、跳转等回调。

接入代码

广告位对象创建时必须传入广告位ID

xxxxxxxxxx
@interface QuMengFeedSingleViewController () <QuMengFeedAdDelegate>
@property (nonatomic, strong) QuMengFeedAd *feedAd;
@end

@implementation QuMengFeedSingleViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    self.feedAd = [[QuMengFeedAd alloc] initWithSlot:self.slot];
    ///  固定宽度高度自适应
    CGFloat width = [[UIScreen mainScreen] bounds].size.width;
    self.feedAd.customSize = CGSizeMake(width - 40, 0);
    [self.feedAd loadAdData];
    // Do any additional setup after loading the view.
}

- (void)setLayoutSubview {
//    self.feedAd.feedView.frame = CGRectMake(0, 200, self.view.frame.size.width, 400);
      [self.view addSubview:self.feedAd.feedView];
//    [self.feedAd.feedView mas_makeConstraints:^(MASConstraintMaker *make) {
//        make.center.mas_equalTo(self.view);
//        make.size.mas_equalTo(self.feedAd.feedView.frame.size);
//    }];
    
    CGFloat scr =  self.feedAd.feedView.frame.size.height / self.feedAd.feedView.frame.size.width;
    [self.feedAd.feedView mas_makeConstraints:^(MASConstraintMaker *make) {
        make.center.mas_equalTo(self.view);
        make.left.mas_equalTo(20);
        make.right.mas_equalTo(-20);
        make.height.mas_equalTo(self.feedAd.feedView.mas_width).multipliedBy(scr);
    }];        
}

// MARK: - QuMengFeedAdDelegate
- (void)qumeng_feedAdLoadSuccess:(QuMengFeedAd *)feedAd {
    NSLog(@"【媒体】信息流: 物料加载成功");
    // 检查广告有效性（1.3.7及以上版本支持）
    [feedAd isValid];
    [self setLayoutSubview];
}

信息流回调说明

媒体自渲染广告

简介

媒体自渲染广告使用 QuMengNativeAd 对象管理信息流广告所有业务。 接入方式上，使用 QuMengNativeAd 对象调用 loadAdData 方法请求广告，调用 show 方法展示广告，通过设置 QuMengNativeAdDelegate 代理，获取广告加载、渲染、点击、跳转等回调。 自渲染广告需要调用 registerContainer:withClickableViews: 方法，否则回调无法触发

接入代码示例

广告位对象创建时必须传入广告位ID

xxxxxxxxxx
@interface QuMengNativeAdSingleViewController () <QuMengNativeAdAdDelegate>
@property (nonatomic, strong) QuMengNativeAdAd *nativeAd;
@property (nonatomic, strong) UIImageView *imageView;

@property (nonatomic, strong) UILabel *jumpLabel;

@end

@implementation QuMengNativeAdSingleViewController

-(UIImageView *)imageView {
    if (!_imageView) {
        _imageView = UIImageView.new;
    }
    return _imageView;
}

- (UILabel *)jumpLabel {
    if (!_jumpLabel) {
        _jumpLabel = [[UILabel alloc] init];
        _jumpLabel.text = @"点击跳转";
    }
    return _jumpLabel;
}

- (void)viewDidLoad {
    [super viewDidLoad];
    self.nativeAd = [[QuMengNativeAdAd alloc] initWithSlot:self.slot];
    self.nativeAd.delegate = self;
    [self.nativeAd loadAdData];
    //    nativeAd load
    // Do any additional setup after loading the view.
}

- (void)setLayoutSubview {
    BOOL isVideo = self.nativeAd.meta.getMaterialType == 4 || self.nativeAd.meta.getMaterialType == 12;
    UIView *materialView = isVideo ? self.nativeAd.videoView: self.imageView;
    [self.view addSubview:materialView];
    
    [self.view addSubview:self.jumpLabel];
    [materialView mas_makeConstraints:^(MASConstraintMaker *make) {
        make.left.mas_equalTo(20);
        make.center.mas_equalTo(0);
        make.height.mas_equalTo(200);
    }];
    
    [self.jumpLabel mas_makeConstraints:^(MASConstraintMaker *make) {
        make.centerX.mas_equalTo(0);
        make.top.mas_equalTo(materialView.mas_bottom).offset(10);
    }];
}

// MARK: QuMengNativeAdAdDelegate
- (void)qumeng_nativeAdLoadSuccess:(QuMengNativeAdAd *)nativeAd {
    NSLog(@"【媒体】自渲染: 请求成功");
    // 检查广告有效性（1.3.7及以上版本支持）
    [nativeAd isValid];
    /// 视频
    if (nativeAd.meta.getMaterialType == 4 || nativeAd.meta.getMaterialType == 12) {
        [nativeAd registerContainer:self.view withClickableViews:@[self.jumpLabel]];
    } else {
        /// 图片
        [self.imageView yy_setImageWithURL:[NSURL URLWithString:nativeAd.meta.getMediaUrl] placeholder:nil];
        [nativeAd registerContainer:self.view withClickableViews:@[self.jumpLabel]];
    }
    [self setLayoutSubview];
}

媒体自渲染回调说明

自渲染摇一摇组件

使用说明

版本要求大于等于 1.3.1，可参考 Demo 中 QMNativeCell 类

1.3.7 及之后版本不再支持

xxxxxxxxxx
// 声明成员变量
@property (nonatomic, strong) QMNativeAdShakeView *shakeView;

// 初始化 QMNativeAdShakeView
- (QMNativeAdShakeView *)shakeView {
  if (!_shakeView) {
    QMNativeAdShakeView *shakeView = [[QMNativeAdShakeView alloc] init];
  }
  return _shakeView;
}

// 绑定自渲染广告对象
self.shakeView.nativeAd = nativeAd;

// 开启摇一摇
[self.shakeView startShake];

// 停止摇一摇
[self.shakeView stopShake];

自渲染滑一滑组件

使用说明

版本要求大于等于 1.3.2，可参考 Demo 中 QMNativeCell 类

xxxxxxxxxx
// 声明成员变量
@property (nonatomic, strong) QMNativeAdSlideView *slideView;

// 初始化 QMNativeAdSlideView
- (QMNativeAdSlideView *)slideView {
    if (!_slideView) {
        _slideView = [[QMNativeAdSlideView alloc] init];
    }
    return _slideView;
}

// 绑定自渲染广告对象
self.slideView.nativeAd = nativeAd;

竞价结果通知

提供竞价成功和失败的通知功能，便于广告业务处理。

成功通知

xxxxxxxxxx
- (void)winNotice:(NSInteger)auctionSecondPrice;

参数说明

描述

当竞价成功时调用此方法，告知竞价第二名的出价金额。

失败通知

xxxxxxxxxx
- (void)lossNotice:(NSInteger)auctionPrice 
         lossReason:(QuMengLossReason* _Nullable)lossReason 
          winBidder:(QuMengWinBidder* _Nullable)winBidder;

参数说明

描述

当竞价失败时调用此方法，告知失败原因及胜出者信息

广告有效性

广告有效性接口

xxxxxxxxxx
// 是否有效 YES: 有效 NO: 无效
- (BOOL)isValid;

微信小程序/小游戏跳转接入方案

步骤 1：创建移动应用

进入 微信开放平台 创建移动应用，并获取相应的微信 AppID。

步骤 2：嵌入最新版 OpenSDK

在移动端嵌入最新版 OpenSDK（仅嵌入即可，无需额外开发工作），并确保版本为 1.8.6 及以上。

步骤 3：关联微信 AppID

在 趣盟平台 将微信开放平台填写的 AppID 与当前应用进行关联。

• 注意：

  • 对于 iOS 应用，需额外填写 universal_link。

步骤 4：更新趣盟 SDK

嵌入并更新趣盟 SDK 至 1.3.1 或以上版本。

注意事项

• 确保所有相关 SDK 均为最新版本以避免兼容性问题。

• 确保微信开放平台中的配置与趣盟平台的关联信息完全一致。

• 对于 iOS 设备，务必正确填写 universal_link，以保证正常跳转。

TopOn聚合平台自定义广告接入文档

简介

Topon自定义广告接入地址：https://help.takuad.com

接入方式

将 QMTopOnSDK.xcframework 集成到项目中

或者使用 CocoaPods 集成

xxxxxxxxxx
pod "QMTopOnSDK", path: "../QMTopOnSDK"

广告类型及服务器配置参数

Gromore聚合平台自定义广告接入文档

简介

Gromore自定义广告接入地址：https://www.csjplatform.com/gromore

接入方式

将 QuMengGromoreSDK.xcframework 集成到项目中

或者使用 CocoaPods 集成

xxxxxxxxxx
pod "QuMengGromoreSDK", path: "../QuMengGromoreSDK"

广告类型及服务器配置参数

接口说明

错误码

SDK版本发布记录