更新日志

1. 环境准备

• Gradle编译环境（Android Studio）

2. SDK接入

方式一：自动集成（推荐使用）

在project级别的build.gradle文件中添加Maven的仓库地址

示例：

在主module的build.gradle文件添加SDK依赖

注意： 6.x 版本开始，app级别的build.gradle,需要添加kotlin相关依赖，如已经添加，可忽略implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.3.61"

方式二：手动集成

如果已经远程引入安装SDK，请忽略此步骤。下载 RangersAppLog Android SDK 解压，将 aar、jar 引入项目libs文件夹。在AndroidStudio项目中，打开project级别的build.gradle，添加：

在app module的build.gradle并在dependencies中添加：

3. SDK所需的App权限

SDK需要以下权限，建议在SDK初始化之前尽可能申请到对应权限，否则可能会影响归因结果

注：Android 6.0及以上版本，需要在运行时动态检查和申请权限。

4. 初始化SDK

初始化RangersAppLog需要尽可能早，如有合规场景，请在同意隐私协议后初始化。

提示：本SDK默认支持多进程初始化

初始化参数说明
appid	channel
为AdSpark(增长参谋)应用列表中生成的AppID	自定义，一般为应用市场名称

5. 埋点设计和规范

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

如果需要此功能，须根据深度事件进行自定义埋点，然后在平台创建推广活动后关联回传事件类型

5.1 系统事件

5.2 自定义事件

设计深度事件埋点时，注意要埋点隔离，避免同一个自定义事件名称用来上报多个深度事件类型，否则会有数据GAP问题，建议直接使用AdSpark(参谋)提供的埋点设计，如有自定义埋点需求，尽量对齐格式。

考虑到开发者事件名称可能和参谋归因产出的激活重复导致数据GAP，禁止开发者使用activation,$activation,app_launch,zzcm_quickpush_activation这四个埋点事件名称

以下是AdSpark(增长参谋)提供的埋点规范代码，可直接复制到应用内使用

6. 埋点上报

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

上报事件和对应属性的代码埋点，适用于需要携带额外参数上报，例如上报付费场景，自定义事件名称为grown_attribution_event_purchase，以下为两种上报方式示例，选择其中一种即可

• 回传要求：自定义/深度事件名称为英文格式，自定义属性下划线+小写英文字母，如user_id，需要注意的是只有自定义事件支持上报事件属性，预置事件不支持
• 获取方式：Push回传的归因数据中 event_name为事件名称，event_params为该事件自带的事件属性。

7. 接入常见问题

更多问题解决和自查请参考广告监测：用户自查手册

7.1 接入问题FAQ

Q ：归因服务接入联调时数据有效缓存是多久？

A ：SDK初始化即可上报launch和terminal事件，需要检查csj_attribution，此事件24小时有效，一般正常初始化SDK几分钟后即可到平台查看接入是否成功

Q ：初始化时channel该怎么填？

A： channel为自定义参数，通常定义为上架的应用市场名称，比如huawei、oppo、vivo等

Q ：接入归因服务联调报错时显示缺少csj_attribution回传

A ：新接入归因服务的应用必须要设置header（csj_attribution=1），且后续发版要一直保留，缺失会影响归因结果，造成不必要的数据GAP，强烈建议在初始化后设置，具体设置方法如下：AppLog.setHeaderInfo("csj_attribution",1);

Q：接入归因SDK后输出错误日志http responseBody: {"code":40009,"message":"current app id is not tracer app, will skip","data":null}

A： 不影响实际业务和数据，开发者可以忽略该报错。

7.2通用问题

Q：客户端是否支持通过接口获取归因结果？

A：暂时还不支持通过客户端接口获取归因结果，开发和可以接入push回传能力接收归因数据：adspark会将归因结果实时推送到开发者指定的收数地址，详细请参Push API接入说明；

Q：adspark支持哪几种归因方式？

A：归因方式：①精准归因；②模糊归因；③精准归因+模糊归因，建议开发者选择第三种，会提高整体的归因率；精准归因主要是通过设备号id来mapping，因此强烈建议开发者初始化归因SDK时尽量允许获取oaid、imei、Androidid等设备号，若SDK将获取开关关闭/用户不允许获取imei，adspark也会通过ipua等方式进行模糊归因；

8. 自查工具使用

8.1 Maven仓库引入

在主module的build.gradle文件添加SDK依赖，如已添加，请忽略此步骤

8.2 功能说明

8.2.1 面板入口

打开应用后会看到一个悬浮的按钮，按钮下方是本次启动后产生的事件总数和上报完成百分比（已上报到服务端的事件数/累计采集的事件数），点击该按钮后会打开工具面板。

• DevTools面板页面分标题区、内容区两个部分：
• 标题区：显示子页面标题、显示APP ID（可切换多实例）和关闭面板按钮；
• 内容区：显示各个功能栏的具体内容。

8.2.1.1 关闭悬浮入口

悬浮按钮默认在App启动后常驻吸边显示，可拖动调整位置。如果需要隐藏悬浮按钮，可以通过以下两种方式关闭：

1. 一般建议在App的Debug页面（或开发者工具页面）添加一个新的按钮，来控制悬浮按钮的显示和隐藏。开关的值会默认持久化到本地。

DevTools v3.1.0+版本新接口
注意：在Application的初始化中调用该接口不会生效。

2. 在DevTools设置页面关闭悬浮显示：

8.2.1.2 手动显示面板

在关闭了悬浮按钮后，如果需要打开DevTools面板，可以在任意位置通过调用以下方法显示：

DevTools v3.1.0+版本新接口

8.2.2 接入栏

首次使用DevTools面板默认显示的是接入栏。接入栏中显示了DevTools对增长营销套件SDK的核心信息的检查结果。首次接入增长营销套件SDK时可以通过该栏信息判断是否接入成功。

• 版本检查：初始化AppLog后会显示版本号和是否接入全埋点。
• 初始化检查：显示了核心的初始化信息，包含APP ID、渠道、启动状态和服务环境。启动状态：已初始化：执行了AppLog.init之后的状态；已启动：SDK开始正常工作后的状态。

• 服务接口检查：显示核心网络请求是否正常。
• 埋点上报检查：显示埋点从采集、本地缓存到上报的过程是否正常。

8.2.3 配置栏

在DevTools面板中的导航栏点击“配置”即可切换到配置栏。配置栏中显示了埋点SDK接入成功的各种配置和下发的参数信息：

• 基本信息：包含设备注册相关的SSID、uuid、bd_did等信息；
• 初始化配置：包含初始化传入的参数以及实时设置的配置信息；
• 服务端配置：包含服务端下发的配置信息；
• 公共参数配置：包含采集的设备信息和自定义公参，并标记敏感参数；

配置 -> 公共参数配置-> 检查header携带csj_attribution情况

其他设备ID（IMEI、OAID）也可一并检测

8.2.4 事件栏

在DevTools面板中的功能栏点击“事件”即可切换到事件栏。通过实时查看事件信息可以检查事件参数等是否正确。事件栏功能包含：

• 搜索区：事件列表支持按关键字、事件类型、上报状态、录入状态搜索，支持按时间正序、倒序排列，支持清空当前面板的事件列表，支持手动拉取数据管理中的元数据信息；
• 事件区：事件列表包含事件的产生时间、事件类型、事件状态等基本信息，点击单个事件可以查看事件详细内容（JSON格式），长按单个事件可以复制事件内容到剪切板。事件状态：已采集：表示事件已产生；已落库：表示事件已缓存到本地；已上报：表示事件已通过网络请求上传到服务端。

8.2.5 日志栏

在DevTools面板中的功能栏点击“日志”即可切换到日志栏。通过查看错误日志等可以快速排查接入等问题。日志栏功能包含：

• 搜索区：支持按关键字、功能模块、日志级别搜索，支持按时间正序、倒序排列，支持清空当前列表的全部日志、支持分享所有日志（含被清空的日志）到第三方应用；
• 日志区：实时显示增长营销套件SDK产生的所有日志（无需打开日志开关），点击单个日志可以查看日志详情，日志详情支持复制内容到剪切板，支持解析JSON内容并格式化显示JSON。

8.2.6 网络栏

在DevTools面板中的功能栏点击“网络”即可切换到网络栏。通过网络请求的状态和请求体可以查看埋点上报是否成功。网络栏功能包含：

• 搜索区：支持按URL、接口类型、请求方式搜索，支持按时间正序、倒序排序，支持清空当前列表的网络请求；

• 网络区：包含请求时间、耗时、状态码、请求方法等基本信息，点击单个网络请求可以查看详细信息。详情的单个信息内容可长按复制到剪切板。网络请求详细信息包含：完整URL请求的Headers请求体（支持JSON格式化查看）响应的Headers响应体（支持JSON格式化查看）