SDK 接入准备及初始化文档
大约 5 分钟
SDK 接入准备及初始化文档
概述
说明
本文档旨在为 iOS 应用开发者提供快速集成优推流量变现平台的指南。通过简单的配置步骤,您即可在应用内展示个性化广告。请详细阅读本文档,了解 SDK 的详细使用方式。
术语介绍
AppID:应用 ID,是您在优推流量变现平台创建应用时获取的 ID,此 ID 是我们识别您应用的唯一 ID。
SposID:代码位 ID,是您在优推流量变现平台创建代码位时获取的 ID,此 ID 是我们识别您应用下代码位的唯一 ID。
SDK接入准备
- 在优推平台注册账号后,创建应用、代码位。
a. 开发联调阶段建议创建测试应用/代码位,测试代码位几乎满填,方便验证广告加载和展示效果。 - 下载 SDK 并集成到应用内。集成完毕后,首先需要先初始化SDK,并填写平台创建的AppID(应用ID)。然后根据您的需求接入不同的广告功能,按照规范调用各个广告类型方法。
- 每一次广告加载时都需要填写sposId(代码位ID)。
SDK 集成
远程pod库集成(推荐)
- 在podfile中添加
source 'https://github.com/CocoaPods/Specs.git'
source 'https://e.coding.net/gameley/lemon/Lemon-iOS-Specs.git'
- 在podfile中添加,并执行
pod install
即可。
pod 'YouTuiAdSDK'
手动集成
1.下载SDK文件。
SDK 下载地址:开发者可以从下载中心获取
2.在工程文件->general->Frameworks, Libraries, and Embedded Content-> 点击+ 添加:
YouTuiAdSDK.xcframework
YTRelayFoundation.xcframework
YouTuiAdSDK.bundle
3.添加第三方依赖库。
SDWebImage // 5.x
SDK初始化示例
#import <YouTuiAdSDK/YouTuiAdSDK.h>
YTAdSDKConfig *config = [[YTAdSDKConfig alloc] init];
config.appId = @"app id";
[[YTAdSDK shared] setupWithConf:config];
YTAdSDKConfig介绍
YTAdSDKConfig属性 | 含义 | 是否必选 |
---|---|---|
appId | 应用ID | 必选 |
debug | 开发阶段控制台日志,默认为NO,开启后输出控制台日志,上线前须设置为NO | 可选 |
location | 可选 | |
IDFA | 可选 | |
自定义idfa,开发者可自行获取传入idfa。传入非空的字符串后,sdk将不再主动获取。注意要传入正确的idfa,不要随意填写内容。 | 可选 |
广告竞价(bidding)
开发者可以通过获取广告价格信息来自定义广告竞价策略,决定在应用中展示哪些广告。提供的接口功能包括:
- 获取竞价广告实时报价;
- 竞价成功后,上报排名第二的价格;
- 竞价失败时,反馈失败原因及胜出方的相关信息。
YTAdBiddingProtocol 协议介绍
优推ADN的所有广告类型都遵守YTAdBiddingProtocol
协议
协议方法 | 说明 |
---|---|
- (NSString *)getEcpm; | |
- (void)notifyBiddingWin:(CGFloat)ecpm currency:(YTAdCurrencyType)currency adnType:(YTAdAdnType)adnType ext:(NSDictionary *)ext; | |
- (void)notifyBiddingLose:(CGFloat)ecpm currency:(YTAdCurrencyType)currency adnType:(YTAdAdnType)adnType loseReason:(YTAdLoseReasonType)loseReason ext:(NSDictionary *)ext; |
竞价成功
当优推ADN竞胜时,在展示之前通过广告对象调用,调用 notifyBiddingWin:currency:adnType:ext: 方法回传竞败方价格排名第二的竞价信息
参数 | 含义 | 是否必填 |
---|---|---|
ecpm | 最大竞败方出价,单位:分 | 是 |
currency | 币种 | 是 |
adnType | 最大竞败方渠道 | 是 |
ext | 备用额外字段 | 否,无特殊需求传nil |
竞价失败
当优推ADN竞败时,通过广告对象调用 notifyBiddingLose:currency:adnType:loseReason:ext: 方法回传竞胜方的竞价信息
参数 | ||
---|---|---|
是 | ||
币种枚举
币种枚举 | 含义 |
---|---|
竞价渠道枚举
竞价渠道枚举 | 含义 |
---|---|
竞败失败原因枚举
竞价渠道枚举 | 含义 |
---|---|