中文
登录
后可查看全部文档
增长参谋/技术接入文档/广告监测服务/归因服务接入-iOS
归因服务接入-iOS
最近更新 2023-04-24 15:20:19

重要提示:

  1. 归因服务接入后,会关联归因接入兼容数据接入,全部联调成功后,需要有真实归因数据进来才能真正接入成功,需要创建推广活动,用生成的监测链接配置在对应投放平台上
  2. oppo投放渠道配置监测链接门槛:需连续7天投放消耗在1w以上
  3. 支持渠道:归因服务支持渠道

1. 环境准备

  • iOS 8.0 及以上
  • Xcode 10.0+

2. 导入SDK

2.1 使用CocoaPods安装SDK

在Podfile中,添加source源:

2.2 引入SDK

在Podfile中,引入SDK,并执行pod install --repo-update更新Pods。

3. 渠道接入指南(仅以下渠道投放时需要接入)

3.1Apple Search Ads(ASA)

3.1.1 原理介绍

对于iOS 14.3之前的操作系统,apple search ads通过iAd framework来进行归因监测。

对于iOS 14.3及之后的操作系统,apple search ads通过新的Ad Services framework来进行归因监测。

3.1.2 SDK集成

3.1.2.1 自动集成

集成RangersAppLog SDK,确认版本号 >= 6.5.0,如果版本号低于6.5.0,将无法正确监测apple search ads渠道的广告活动。

SDK默认不支持apple search ads归因,如果需要开启apple search ads,确保包含ASA子库。集成ASA子库后,SDK初始化时会获取apple search ads的归因数据,并在注册和激活请求时上报。

另外需要注意的是:iAd API请求时间较长,延迟大约为400-500ms,会导致后续事件依次延迟。SDK中包含Flags/DisableiAd子库,作为关闭iAd的开关。如果关闭了iAd,那么对于iOS 14.3之前的操作系统无法获取归因结果。

3.1.2.2 手动集成

下载 RangersAppLog iOS—ASA SDK 并解压缩。将安装包下的文件复制到项目文件夹下,并在XCode中依次添加到项目中,注意:ASA 渠道包SDK仅比普通包多了一个库文件libRangersAppLog_ASA_awesome_ios.a,请注意区分。

RangersAppLog iOS-ASA.zipRangersAppLog iOS-ASA.zip
0

除此之外,需要在项目中添加依赖:iAd.frameworkAdServices.framework,添加两个framework依赖的时候要额外补充:添加iAd.framework时需要选择require(强引用),AdServices.framework需要选择optional(弱引用),否则在iOS 14.3以下版本中会因为找不到AdServices导致崩溃。

4. 手动安装SDK

注意 6.x 版本开始默认不提供 sdk 包,需要的话请联系技术支持。下载 RangersAppLog iOS SDK 并解压缩。将安装包下的文件复制到项目文件夹下,并在XCode中依次添加到项目中。

RangersAppLog iOS.zipRangersAppLog iOS.zip
0

4.1 添加依赖

将安装包下的文件复制到项目文件夹下,并在XCode中依次添加到项目中。添加依赖:

  • libz.tbd
  • libsqlite3.tbd
  • CoreGraphics.framework
  • Security.framework
  • CoreTelephony.framework (读取运营商名称)
  • SystemConfiguration.framework (判断网络状态)
  • JavaScriptCore.framework
  • WebKit.framework
  • AdSupport.framework (不使用全埋点或圈选功能就不需要依赖)
  • AppTrackingTransparency.framework (不集成Unique模块不需要依赖)

设置 Build Settings -> Linking -> Other Linker Flags 添加 -ObjC:

5. 配置Scheme(可选)

如需使用实时埋点检测圈选事件,请配置Scheme。否则可跳过此步骤。

5.1 获取URL Scheme

「应用列表」-> 接入应用的「详情」->「URL Scheme」中可查看您的scheme,一般为rangersapplog.xxxxx的形式。

5.2 添加URL Scheme

将URL Scheme添加到你的项目中:

5.3 重写回调方法

请根据需要使用实时埋点检测或圈选事件功能的设备版本,并添加URL的处理。 在AppDelegate回调里面添加 URL 的处理。

在 iOS 13+ 版本中,使用 UISceneSession 需要在 UISceneDelegate 回调方法添加URL的处理。

6. 初始化SDK

请在App启动完成的时候,就初始化配置(如果在页面展示完毕之后 才初始化配置,会导致部分事件采集有缺失)。

初始化参数说明

appid

channel

为增长参谋应用列表中生成的AppID




自定义,一般为应用市场名称

7. 联调管理

此功能是参谋为了配合投放侧的联调,通过对设备加白,解除投放平台联调需要新设备的限制

7.1 启用延迟深度链接

在iOS650版本及之前默认是启用的,为了对齐Android,在iOS660版本之后需要配置开启,代码:config.enableDeferredALink = YES; 如果在iOS650及之前使用了ALink,在升级到新版本后一定要开启

7.2 SDK集成onAttributionData方法

在AppDelegate中通过实现onAttributionData 来获取每一次安装用户的归因数据,继而进行下一步行为。

7.3 注意事项

  • 下载应用或者使用本地应用并打开时,需提前开启隐私授权,并保证在SDK初始化之前进行
  • 深度事件联调时需真机打开应用并保证触发,用于联调深度事件的设备需预先触发激活,可先联调激活,并于5min内继续联调深度事件
  • 监测留存事件,如监测失败,可选择手动上报快速完成联调
  • 联调管理加白的did要与实际联调设备的did保持一致,否则加白效果不生效

7.4 抓包验证

以上检查配置项都完成后,可以在窗口期内卸载重装通过抓包确认联调数据是否触发

抓包接口

  1. https://toblog-alink.ctobsnssdk.com/service/2/attribution_data
  2. https://alink.volceapplog.com/service/2/attribution_data
  3. 或者其他带有alink开头的域名,以上检测到任一一个接口即可

8. 深度事件回传(可选)

如果在广告投放平台进行投放时只统计激活数,可忽略此步骤。

如果需要此功能,须根据深度事件进行自定义埋点,然后在增长参谋创建推广活动的时候做关联

8.1 系统事件

系统深度事件

事件类型

事件名称(自定义)

上报时机

激活(系统自带,可以不用埋点)

activation

-

留存(系统自带,可以不用埋点)

app_launch

-

8.2 自定义事件

自定义深度事件

事件类型(固定)

事件名称(自定义)

上报时机(自定义)

注册

例:register

根据业务场景

付费

例:pay

根据业务场景

订单

例:order

根据业务场景

关键行为

例:key_behavior

根据业务场景

下载

例:download

根据业务场景

注:自定义埋点事件设计原则如下:

  • event 命名仅支持字母(建议小写)、数字和下划线,不要使用 launch、terminate等系统内置事件名
  • param 命名仅支持字母(建议小写)、 数字和下划线
  • _param 的值仅支持以下类型(请按实际数据类型填写,便于后续计算分析),不支持数组和对象
  • 字符串
  • 整型
  • 浮点型_
  • param 值空的含义,建议用“be_null”,不建议使用""或" "

8.3 BD_DID获取

客户端如需要唯一性ID来处理业务逻辑,可以通过SDK获取

Objective-C请参考:

Swift请参考:

9. 埋点上报

用户行为日志采用事件event + 属性params的形式,事件一般对应多个属性,也可以仅有事件没有属性。代码埋点方案一般由数据分析师或产品运营设计。仅上报事件的代码埋点,示例如下:

Objective-C请参考:

Swift请参考:

上报事件和对应属性的代码埋点,示例如下:

Objective-C请参考:

Swift请参考:

例如上报付费场景,自定义事件名称为pay,以下为两种上报方式示例,选择其中一种即可

10. 埋点验证

客户端埋点后,需要手动触发,并通过Charles抓包确认埋点是真实上报到服务端的

10.1 关闭加密开关

本地验证阶段,为方便抓包验证埋点,需要把加密开关关闭,上线后建议再开启

10.2 验证上报参数

自定义埋点触发后会通过相关接口上报埋点信息,需要确认下是否包括自定义埋点事件

10.2.1 激活上报

抓包接口:https://klink.volceapplog.com/service/2/app_alert_check/,接口返回报文如下代表激活已经成功上报

10.2.2 自定义埋点上报

抓包接口:https://toblog.volceapplog.com/service/2/app_log,检查请求参数中是否携带自定义的事件名称,如有代表自定义事件埋点成功且正常上报

以上激活和相关自定义埋点事件验证成功后,可以跟对应投放平台联调后进行投放


本篇目录
联系我们