跳至主要內容

SDK 接入准备及初始化文档

大约 8 分钟

SDK 接入准备及初始化文档

概述

说明

本文档旨在为 iOS 应用开发者提供快速集成优推流量变现平台的指南。通过简单的配置步骤，您即可在应用内展示个性化广告。请详细阅读本文档，了解 SDK 的详细使用方式。

术语介绍

AppID：应用 ID，是您在优推流量变现平台创建应用时获取的 ID，此 ID 是我们识别您应用的唯一 ID。

SposID：代码位 ID，是您在优推流量变现平台创建代码位时获取的 ID，此 ID 是我们识别您应用下代码位的唯一 ID。

SDK接入准备

  1. 在优推平台注册账号后，创建应用、代码位。
    a. 开发联调阶段建议创建测试应用/代码位，测试代码位几乎满填，方便验证广告加载和展示效果。

  2. 下载 SDK 并集成到应用内。集成完毕后，首先需要先初始化SDK，并填写平台创建的AppID（应用ID）。然后根据您的需求接入不同的广告功能，按照规范调用各个广告类型方法。

  3. 每一次广告加载时都需要填写sposId（代码位ID）。

  4. YouTuiAdSDK Demoopen in new window

  5. 配置白名单（info.plist->LSApplicationQueriesSchemes中配置）。

    为了提高广告填充率，建议媒体接入前按照下方白名单进行配置，注意数量不要超过50个。最后的效果如下图：

image.png

请使用这个白名单：

应用名称scheme
京东openapp.jdmobile
淘宝tbopen
手机天猫tmall
支付宝alipays
拼多多pinduoduo
美团imeituan
美团外卖meituanwaimai
携程旅行ctrip
uc浏览器uclink
夸克qklink
手机百度baiduboxapp
飞猪旅行taobaotravel
汽车之家autohome
1688wireless1688
高德地图amapuri
饿了么eleme
快手kwai
快手极速版ksnebula
滴滴出行OneTravel
B站bilibili
大众点评dianping
微博sinaweibo
唯品会vipshop
斗鱼dydeeplink
肯德基kfcapplinkurl
腾讯视频txvideo
抖音短视频snssdk1128
贝壳找房lianjiabeike
苏宁易购suning
腾讯新闻qqnews
全民K歌qmkkge
知乎zhihu
爱奇艺iqiyi
58同城wbmain
闲鱼fleamarket
哔哩哔哩bilibili
优酷视频youku
今日头条极速版snssdk35
QQ音乐qqmusic
安居客openanjuke
喜马拉雅iting
京东金融jdmobile
马蜂窝旅游travelguide
去哪儿旅行qunarphone
同程旅行tctclient
口碑koubei
点淘taobaoliveshare
掌上生活cmblife
映客market
小红书xhsdiscover://
百度极速版baiduboxlite://

SDK 集成

远程pod库集成（推荐）

  1. 在podfile中添加
source 'https://github.com/CocoaPods/Specs.git'
  1. 在podfile中添加，并执行pod install即可。
pod 'YouTuiAdSDK'

手动集成

1.下载SDK文件。

SDK 下载地址：开发者可以从下载中心open in new window获取

2.在工程文件->general->Frameworks, Libraries, and Embedded Content-> 点击+ 添加：

YouTuiAdSDK.xcframework
YTRelayFoundation.xcframework
YouTuiAdSDK.bundle

SDK初始化示例

#import <YouTuiAdSDK/YouTuiAdSDK.h>
YTAdSDKConfig *config = [[YTAdSDKConfig alloc] init];
config.appId = @"app id";
[[YTAdSDK shared] setupWithConf:config result:^(BOOL result, NSString * _Nonnull errorMsg) {
    if (result) {
        NSLog(@"初始化成功");
    } else {
        NSLog(@"初始化失败，errMsg：%@", errorMsg);
    }
}];

YTAdSDKConfig介绍

YTAdSDKConfig属性含义是否必选
appId应用ID必选
debug开发阶段控制台日志，默认为NO，开启后输出控制台日志，上线前须设置为NO可选
location可选
IDFA可选
自定义idfa，开发者可自行获取传入idfa。传入非空的字符串后，sdk将不再主动获取。注意要传入正确的idfa，不要随意填写内容。可选
个性化推荐开关，默认YES。设置为NO后，sdk将不再根据个性化能力推荐广告。（2.12.1版本开始支持）可选
自定义位置信息，开发者可以自行获取传入。（2.12.2版本开始支持）可选
是否允许SDK获取idfv，default YES；设置为NO后，sdk不会再获取idfv信息。（2.12.2版本开始支持）可选
自定义idfv，开发者可以自行获取idfv传入。（2.12.2版本开始支持）可选
是否允许SDK获取运营商信息，default YES；设置为NO后，SDK不会再获取运营商信息。（2.12.2版本开始支持）可选
自定义运营商信息，开发者可以自行获取运营商信息传入，格式为mcc拼接mnc，如46000。（2.12.2版本开始支持）可选
是否允许SDK使用CoreMotion传感器，default YES；设置为NO后，SDK不会再有摇一摇广告。（2.12.2版本开始支持）可选

广告竞价（bidding）

开发者可以通过获取广告价格信息来自定义广告竞价策略，决定在应用中展示哪些广告。提供的接口功能包括：

  1. 获取竞价广告实时报价；
  2. 竞价成功后，上报排名第二的价格；
  3. 竞价失败时，反馈失败原因及胜出方的相关信息。

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: 方法回传竞胜方的竞价信息

参数
是

币种枚举

币种枚举含义

竞价渠道枚举

竞价渠道枚举含义

竞败失败原因枚举

竞价渠道枚举含义
上次编辑于: