发布时间 | 更新说明 | |
2024-9-19 |
| 赵娇娇 |
2024-8-9 |
| |
2024-6-11 |
| |
2023-8-17 |
| |
2023-6-12 |
| |
2023-3-2 |
| |
2023-1-10 |
| |
2022-10-17 |
| |
2022-9-21 |
| |
2022-8-29 |
| |
2022-7-15 |
|
重要提示:
在Podfile中,添加source源:
在Podfile中,引入SDK,并执行pod install --repo-update
更新Pods。
注意 6.x 版本开始默认不提供 sdk 包,需要的话请联系技术支持。下载 RangersAppLog iOS SDK 并解压缩。将安装包下的文件复制到项目文件夹下,并在XCode中依次添加到项目中。
将安装包下的文件复制到项目文件夹下,并在XCode中依次添加到项目中。添加依赖:
设置 Build Settings -> Header Search Paths 添加 Headers 文件夹路径:
设置 Build Settings -> Linking -> Other Linker Flags 添加 -ObjC:
对于iOS 14.3之前的操作系统,apple search ads通过iAd framework来进行归因监测。
对于iOS 14.3及之后的操作系统,apple search ads通过新的Ad Services framework来进行归因监测。
集成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之前的操作系统无法获取归因结果。
下载 RangersAppLog iOS-ASA SDK 并解压缩。将安装包下的文件复制到项目文件夹下,并在XCode中依次添加到项目中,注意:ASA 渠道包SDK仅比普通包多了一个库文件libRangersAppLog_ASA_awesome_ios.a
,请注意区分。
除此之外,需要在项目中添加依赖:iAd.framework
和AdServices.framework
,添加两个framework依赖的时候要额外补充:添加iAd.framework
时需要选择require(强引用),AdServices.framework
需要选择optional(弱引用),否则在iOS 14.3以下版本中会因为找不到AdServices导致崩溃。
如需使用实时埋点检测或圈选事件,请配置Scheme。否则可跳过此步骤。
「应用列表」-> 接入应用的「详情」->「URL Scheme」中可查看您的scheme,一般为rangersapplog.xxxxx
的形式。
将URL Scheme添加到你的项目中:
请根据需要使用实时埋点检测或圈选事件功能的设备版本,并添加URL的处理。 在AppDelegate
回调里面添加 URL 的处理。
在 iOS 13+ 版本中,使用 UISceneSession
需要在 UISceneDelegate
回调方法添加URL的处理。
请在App启动完成的时候,就初始化配置(如果在页面展示完毕之后 才初始化配置,会导致部分事件采集有缺失)。如有合规场景,请在用户授权后再进行 SDK 的初始化。
初始化参数说明 | |
appid | channel |
为AdSpark(增长参谋)应用列表中生成的AppID | 自定义,一般为应用市场名称 |
在AppDelegate中通过实现onAttributionData 来获取每一次安装用户的数据,继而进行下一步行为。如:为安装的用户提供个性化的内容,或者将他们带到App内的指定页面
客户端如需要唯一性ID来处理业务逻辑,可以通过SDK获取
Objective-C
请参考:
Swift
请参考:
如果在广告投放平台进行投放时只统计激活数,可忽略此步骤。
如果需要此功能,须根据深度事件进行自定义埋点,然后在平台创建推广活动后关联回传事件类型
系统深度事件 | ||
事件类型 | 事件名称(系统预置) | 上报时机 |
激活(系统自带) | $activation | 初始化时 |
留存(系统自带) | app_launch | 应用启动时,开发者可以参考6.2自定义深度事件,即可以使用系统采集激活事件(activation)或其他自定义事件,作为「留存的开始事件」,后续每天留存判断事件默认为系统采集app_launch(应用启动) |
激活(系统自带) | zzcm_quickpush_activation | push时 |
设计深度事件埋点时,注意要埋点隔离,避免同一个自定义事件名称用来上报多个深度事件类型,否则会有数据GAP问题,建议直接使用参谋提供的埋点设计,如有自定义埋点需求,尽量对齐格式。
考虑到开发者事件名称可能和参谋归因产出的激活重复导致数据GAP,禁止开发者使用activation,$activation,app_launch,zzcm_quickpush_activation这四个埋点事件名称
自定义深度事件 | ||
事件类型 | 事件名称 | 上报时机 |
注册 | grown_attribution_event_register | 根据业务场景 |
次留 | grown_attribution_event_retention_2d | |
付费 | grown_attribution_event_purchase | |
下单 | grown_attribution_event_order | |
关键行为 | grown_attribution_event_key_behavior | |
下载 | grown_attribution_event_download | |
授权 | grown_attribution_event_authorization | |
拉活 | grown_attribution_event_app_re_active_wake_up | |
应用内拉起 | grown_attribution_event_deelink | |
广告变现 | grown_attribution_event_ad_purchase | |
表单提交 | grown_attribution_event_form_submit | |
添加购物车 | grown_attribution_event_add_to_cart | |
自定义激活 | grown_attribution_event_custom_activition |
以下是参谋提供的埋点规范代码,可直接复制到应用内使用
用户行为日志采用事件event + 属性params的形式,事件一般对应多个属性,也可以仅有事件没有属性。代码埋点方案一般由数据分析师或产品运营设计。仅上报事件的代码埋点,示例如下:
Objective-C
请参考:
Swift
请参考:
上报事件和对应属性的代码埋点,适用于需要携带额外参数上报,例如上报付费场景,自定义事件名称为grown_attribution_event_purchase
,以下为两种上报方式示例,选择其中一种即可
Objective-C
请参考:
Swift
请参考:
更多问题解决和自查请参考广告监测:用户自查手册
Q :归因服务接入联调时数据有效缓存是多久?
A :SDK初始化即可上报launch和terminal事件,需要检查csj_attribution,此事件24小时有效,一般正常初始化SDK几分钟后即可到平台查看接入是否成功
Q :初始化时channel该怎么填?
A: channel为自定义参数,通常定义为上架的应用市场名称,比如AppStore等
Q :接入归因服务联调报错时显示缺少csj_attribution回传
A :新接入归因服务的应用必须要设置header(csj_attribution=1),且后续发版要一直保留,缺失会影响归因结果,造成不必要的数据GAP,强烈建议在初始化后设置,具体设置方法如下:
[BDAutoTrack setCustomHeaderValue:@"1" forKey:@"csj_attribution"]
Q:为什么新建了apple search ads推广活动后没有监测链接?
A:Apple search ads是自归因渠道,不提供监测链接,展点数据通过mapi抓取获得。
Q:怎么确认是否已集成了ASA归因
A:开发者集成时包含了ASA子库,SDK会通过mapi抓取归因结果
Q:ASA投放后,只有激活数据无其他数据(注册、付费等)?
A:ASA只支持激活
Q:为什么AdSpark(增长参谋)广告监测-推广活动分析中显示的数据和apple显示的数据不一致?
A:增长参谋广告监测结果和apple的结果会有一些差异,有以下几个可能的原因:
Q:客户端是否支持通过接口获取归因结果?
A:暂时还不支持通过客户端接口获取归因结果,开发和可以接入push回传能力接收归因数据:adspark会将归因结果实时推送到开发者指定的收数地址,详细请参Push API接入说明;
Q:adspark支持哪几种归因方式?
A:归因方式:①精准归因;②模糊归因;③精准归因+模糊归因,建议开发者选择第三种,会提高整体的归因率;精准归因主要是通过设备号id来mapping,因此强烈建议开发者在允许广告追踪后2s再初始化归因SDK,保证能获取到设备号,若用户不允许追踪,adspark也会通过ipua等方式进行模糊归因;
温馨提示:
①此工具可用于检测Applog初始化状态,Header设置是否正常,埋点是否正常上报,以及涉及到端上其他情况,强烈建议利用起来
②或者直接参考广告监测:用户自查手册 里,埋点验证相关部分使用Charles抓包确认
通过CocoaPods集成DevTools组件,注意:支持的最小版本:6.12.0
完成接入操作后,打开完整的URL即可使用下述功能。
devToolsEnabled 默认为 YES,只有加载了 DevTools 模块才会生效
在开发工具面板中选择【事件】可切换到事件栏,事件栏功能包括
在开发工具面板中选择【基本信息】可切换到信息栏,信息栏功能包括
在开发工具面板中选择【日志】可切换到日志栏,通过查看错误日志等可以快速排查接入等问题。日志栏功能包含:
Online Customer Service24/7 Online Customer Service BotManual customer service, weekdays 10~ 12 o'clock/14~ 19 o'clock