腾讯优量汇 iOS SDK 接入文档

Version: 4.15.10

概述

说明

本文档旨在帮助iOS应用开发者在程序中快速植入腾讯优量汇开发者平台提供的广告。作为应用开发者，您只需要进行简单配置，就可以在您的应用中显示定制的广告。关于 SDK 的具体使用方法，请仔细阅读下面的文档。

背景

开发环境

确保您的开发及部署环境符合以下标准：

• 开发工具：推荐Xcode 14.1及以上版本

• 部署目标：iOS 11.0及以上版本

• SDK版本：官网最新版本

注册开户

开发者需在腾讯优量汇开发者平台上进行注册，在平台审核通过后，开发者就成为了腾讯优量汇的正式会员。

术语介绍

• APPID：媒体 ID，是您在腾讯优量汇开发者平台创建媒体时获得的ID，这个ID是我们在广告网络中识别您应用的唯一ID。

• PlacementId：广告位 ID，是您在腾讯优量汇开发者平台为您的媒体所创建的某种类型的广告位置的ID。

权限申请

部分广告样式的接入需要权限，您可以联系腾讯优量汇运营进行了解和权限申请。在腾讯优量汇开发者平台新建广告位时您只能看到您有相应权限的广告位类型。

说明：针对单媒体的用户，允许获取idfa和定位权限的，投放定向广告；不允许获取权限的用户，投放通投广告，媒体可以选择是否把idfa和定位数据提供给优量汇，并承担相应广告填充和eCPM单价下降损失的结果。

SDK 初始化

SDK 拉取广告之前，必须要进行初始化操作，传入在腾讯优量汇开发者平台注册得到的 APPID。

• 4.14.60及以上版本SDK初始化说明

#import "GDTSDKConfig.h"

BOOL result = [GDTSDKConfig initWithAppId:@"开发者平台注册的APPID"];
if (result) {
    NSLog(@"初始化成功");
}
[GDTSDKConfig startWithCompletionHandler:^(BOOL success, NSError *error) {
    if (success) {
        // 请求广告逻辑处理
    }
}];

• 4.14.60以下版本SDK初始化说明 (注意: 4.14.80版本此接口正式下线)

#import "GDTSDKConfig.h"

BOOL success = [GDTSDKConfig registerAppId:@"开发者平台注册的APPID"];
if (success) {
    // 请求广告逻辑处理
}

禁用IDFA信息

此接口默认值是NO，即同意优量汇SDK获取IDFA信息。
允许流量方设置此接口值为YES，即禁止优量汇SDK获取IDFA信息。方法如下：

#import "GDTSDKConfig.h"

[GDTSDKConfig forbiddenIDFA:YES]; // 禁止优量汇SDK获取IDFA信息，默认值为NO

设置渠道号

渠道号信息主要用来协助平台提升流量变现效果及您的收益，请如实填写，若渠道号无法满足您的诉求请联系平台负责运营。

渠道号映射关系为：

• 1：百度
• 2：头条
• 3：优量汇
• 4：搜狗
• 5：其他网盟
• 6：oppo
• 7：vivo
• 8：华为
• 9：应用宝
• 10：小米
• 11：金立
• 12：百度手机助手
• 13：魅族
• 14：AppStore
• 999：其他

方法如下：

#import "GDTSDKConfig.h"

+ (void)setChannel:(NSInteger)channel;

[GDTSDKConfig setChannel:3];

音频设置

在播放音频时是否使用SDK内部对AVAudioSession设置的category及options，默认使用，若不使用，SDK内部不做任何处理，由调用方在播放视频时自行设置；

SDK设置的category为AVAudioSessionCategoryAmbient，options为AVAudioSessionCategoryOptionDuckOthers

#import "GDTSDKConfig.h"

+ (void)enableDefaultAudioSessionSetting:(BOOL)enabled;

广告位创建流程

在您的媒体通过审核后，可以在腾讯优量汇开发者平台选择“新建广告位”。

步骤说明：

• 1.在新建广告位之前，确保您已经下载最新版SDK并阅读完说明文档，了解如何在您的媒体中使用广告位 ID
• 2.选择需要嵌入广告的媒体名称。注意此处只可选择已通过审核的媒体
• 3.广告位名称用于区分媒体内设置的各个广告位，方便您在后台进行统一管理和查看数据报表；目前支持接入的广告类型包含：开屏广告、激励广告、插屏广告、 横幅(Banner) 广告、信息流广告、详情页插入广告、视频贴片广告等；接入方式包含优量汇渲染、开发者自渲染等
• 4.点击完成按钮以后即获得对应该广告位的 ID 号
• 5.成功得到广告位ID以后，您可以在应用代码内使用该ID进行广告联调测试（见“接入代码”部分）
• 6.通过测试后去掉测试代码部分（TestAd），即可发布带有优量汇广告位的 iOS 应用

支持广告类型

优量汇支持以下几种广告类型，您可以根据开发需要选择合适的广告：