文档中心 | 一键联接，全心服务

更新日期：2024年 04月 12日QuickAD+iOS接入文档

<h3> 一、SDK简述 </h3> PlayAds.framework,整合模拟器和真机架构的静态库framework 支持平台：iPod Touch,iPhone,iPad。系统要求:iOS7.0+, 支持框架: armv7 arm64 i386 x86_64 环境要求：xcode8.0+ <h3> 二、环境配置 </h3> 添加SDK <img src="http://data.quicksdk.net/data/newFiles/image/20180125/1516846470819286.png" title="1516845887658093.png" alt="1.png" /> 将SDK文件PlayAds.framework拖放导入工程；选择正确的target 在Build Settings->Linking->Other Linking Flags 中配置 –ObjC 如果在编译时报错找不到framework头文件，需要手动配置一下framework搜索路径，比如demo中的相对路径配置 <img src="http://data.quicksdk.net/data/newFiles/image/20180125/1516845931477880.png" title="1516845894403632.png" alt="2.png" /> <h3> 三、接口说明 </h3> iOS端的广告系统数据统计一共有六个接口，供外部使用的接口类为PlayAdsManager，各接口使用说明如下： <h4> 3.1.初始化（必接） </h4> 初始化的接口，在进入游戏的时候首先调用 原型：+ (void)initPlayAdsWithProductCode:(NSString *)productCode; 参数说明： <table border="1" cellpadding="0" cellspacing="0" style="width:50%;" class="" bordercolor="#000000"> <tbody> <tr> <td height="22" class="xl65" width="175"> 字段 </td> <td class="xl65" width="144"> 类型 </td> <td class="xl65" width="208"> 说明 </td> </tr> <tr> <td height="22" class="xl65" width="175"> productCode </td> <td class="xl65" width="144"> NSString </td> <td class="xl65" width="208"> 产品码，在Quick后台申请 </td> </tr> </tbody> </table> 使用示例： <pre class="brush:js;toolbar:false">[PlayAdsManager initPlayAdsWithProductCode:@"8cf0c4ea388c7d53435c1e361949f154"];</pre> <h4> 3.2.登录（必接） </h4> 登录成功的上报接口 原型：+ (void)onLoginUid:(NSString *)uid username:(NSString *)name 参数说明： 字段 <table border="1" cellpadding="0" cellspacing="0" style="width:50%;" class="" bordercolor="#000000"> <tbody> <tr> <td height="22" class="xl65" width="175"> 字段 </td> <td class="xl65" width="144"> 类型 </td> <td class="xl65" width="208"> 说明 </td> </tr> <tr> <td height="22" class="xl65" width="175"> uid </td> <td class="xl65" width="144"> NSString </td> <td class="xl65" width="208"> 用户Id </td> </tr> <tr> <td height="22" class="xl65" width="175"> name </td> <td class="xl65" width="144"> NSString </td> <td class="xl65" width="208"> 用户名 </td> </tr> </tbody> </table> 使用示例： <pre class="brush:js;toolbar:false">[PlayAdsManager onLoginUid:@"123456" username:@"name"];</pre> 备注：登录成功或者切换账号成功，都需要调用onLoginUid:username接口。若切换账号成功未调用onLoginUid:usernam接口，可能导致后台uid统计错误。 <h4> 3.3.激活（必接） </h4> 游戏激活上报接口 原型：+ (void)onActivationWithUserUid:(NSString *)uid roleId:(NSString *)roleId 参数说明： <table border="1" cellpadding="0" cellspacing="0" style="width:50%;" class="" bordercolor="#000000"> <tbody> <tr> <td height="22" class="xl65" width="175"> 字段 </td> <td class="xl65" width="144"> 类型 </td> <td class="xl65" width="208"> 说明 </td> </tr> <tr> <td height="22" class="xl65" width="175"> uid </td> <td class="xl65" width="144"> NSString </td> <td class="xl65" width="208"> 用户Id </td> </tr> <tr> <td height="22" class="xl65" width="175"> roleId </td> <td class="xl65" width="144"> NSString </td> <td class="xl65" width="208"> 角色Id </td> </tr> </tbody> </table> 使用示例： <pre class="brush:js;toolbar:false">[PlayAdsManager onActivationWithUserUid:@"123456" roleId:@"name"];</pre> 备注：游戏激活，按需调用，统计游戏激活观察点，不是打开app的设备数, uid 、roleId 可以为nil。 <h4> 3.4.角色信息（必接） </h4> 上传角色信息的上报接口Id 原型：+ (void)updateRoleInfo:(PlayAdsRoleInfo *)roleInfo isCreate:(BOOL)isCreateRole; 参数说明： <table border="1" cellpadding="0" cellspacing="0" style="width:50%;" class="" bordercolor="#000000"> <tbody> <tr> <td height="22" class="xl65" width="175"> 字段 </td> <td class="xl65" width="144"> 类型 </td> <td class="xl65" width="208"> 说明 </td> </tr> <tr> <td height="22" class="xl65" width="175"> isCreateRole </td> <td class="xl65" width="144"> BOOL </td> <td class="xl65" width="208"> 是否为创建角色 </td> </tr> <tr> <td height="22" class="xl65" width="175"> roleInfo.uid </td> <td class="xl65" width="144"> NSString </td> <td class="xl65" width="208"> 登录的用户uid </td> </tr> <tr> <td height="22" class="xl65" width="175"> roleInfo.roleId </td> <td class="xl65" width="144"> NSString </td> <td class="xl65" width="208"> 角色Id，如果没有可填uid </td> </tr> <tr> <td height="22" class="xl65" width="175"> roleInfo.roleName </td> <td class="xl65" width="144"> NSString </td> <td class="xl65" width="208"> 角色名称，如果没有可填角色Id </td> </tr> <tr> <td height="22" class="xl65" width="175"> roleInfo.roleLevel </td> <td class="xl65" width="144"> int </td> <td class="xl65" width="208"> 角色等级，可选 </td> </tr> <tr> <td height="22" class="xl65" width="175"> roleInfo.serverId </td> <td class="xl65" width="144"> NSString </td> <td class="xl65" width="208"> 区服Id,可选 </td> </tr> <tr> <td height="22" class="xl65" width="175"> roleInfo.serverName </td> <td class="xl65" width="144"> NSString </td> <td class="xl65" width="208"> 区服名称,可选 </td> </tr> <tr> <td height="22" class="xl65" width="175"> roleInfo.balance </td> <td class="xl65" width="144"> float </td> <td class="xl65" width="208"> 角色余额，可选 </td> </tr> <tr> <td height="22" class="xl65" width="175"> roleInfo.vipLevel </td> <td class="xl65" width="144"> int </td> <td class="xl65" width="208"> 角色的Vip等级,可选 </td> </tr> <tr> <td height="22" class="xl65" width="175"> roleInfo.partyName </td> <td class="xl65" width="144"> NSString </td> <td class="xl65" width="208"> 所在的帮派名称，可选 </td> </tr> </tbody> </table> 使用示例： <pre class="brush:js;toolbar:false">PlayAdsRoleInfo *roleInfo = [PlayAdsRoleInfo roleInfo]; roleInfo.uid = @"123456"; roleInfo.userName = @"name"; roleInfo.roleId = @"111111"; roleInfo.roleName = @"roleName"; roleInfo.serverName = @"serverName"; roleInfo.roleLevel = 2; roleInfo.vipLevel = 3; [PlayAdsManager updateRoleInfo:roleInfo isCreate:NO];</pre> 备注：需要在创建游戏角色、进入游戏和角色升级3个地方调用此接口，缺一不可。尤其用户角色信息有变化 (如升级) 时必须调用。当创建角色时isCreateRole字段值为true，其它情况为false。 <h4> 3.5.充值（必接） </h4> 支付成功的上报接口 原型：+ (void)congziOverInfo:(PlayAdsOrderInfo *)orderInfo roleInfo:(PlayAdsRoleInfo *)role; 参数说明： <table border="1" cellpadding="0" cellspacing="0" style="width:50%;" class="" bordercolor="#000000"> <tbody> <tr> <td height="22" class="xl65" width="175"> 字段 </td> <td class="xl65" width="144"> 类型 </td> <td class="xl65" width="208"> 说明 </td> </tr> <tr> <td height="22" class="xl65" width="175"> orderInfo.amount </td> <td class="xl65" width="144"> NSString </td> <td class="xl65" width="208"> 订单总金额 </td> </tr> <tr> <td height="22" class="xl65" width="175"> orderInfo.orderNo </td> <td class="xl65" width="144"> NSString </td> <td class="xl65" width="208"> 游戏支付的订单号 </td> </tr> <tr> <td height="22" class="xl65" width="175"> orderInfo.goodsId </td> <td class="xl65" width="144"> NSString </td> <td class="xl65" width="208"> 商品Id </td> </tr> <tr> <td height="22" class="xl65" width="175"> orderInfo.goodsName </td> <td class="xl65" width="144"> NSString </td> <td class="xl65" width="208"> 商品名称 </td> </tr> <tr> <td height="22" class="xl65" width="175"> orderInfo.currency </td> <td class="xl65" width="144"> NSString </td> <td class="xl65" width="208"> 币种 </td> </tr> <tr> <td height="22" class="xl65" width="175"> role </td> <td class="xl65" width="144"> PlayAdsRoleInfo </td> <td class="xl65" width="208"> 角色信息 </td> </tr> </tbody> </table> 使用示例： <pre class="brush:js;toolbar:false">PlayAdsOrderInfo *orderInfo = [PlayAdsOrderInfo orderInfo]; orderInfo.orderNo = [NSString stringWithFormat:@"%.0f",[NSDate timeIntervalSinceReferenceDate]]; orderInfo.goodsId = @"120baoshi"; orderInfo.goodsName = @"120宝石"; orderInfo.amount = 12; orderInfo.currency = @"CNY"; PlayAdsRoleInfo *roleInfo = [PlayAdsRoleInfo roleInfo]; roleInfo.uid = @"123456"; roleInfo.userName = @"name"; roleInfo.roleId = @"111111"; roleInfo.roleName = @"roleName"; roleInfo.serverName = @"serverName"; roleInfo.roleLevel = 2; roleInfo.vipLevel = 3; [PlayAdsManager congziOverInfo:orderInfo roleInfo:roleInfo]; </pre>