1. 集成神策分析 SDK

1.1. 引入插件

project 级别的 build.gradle 文件中添加 Sensors Analytics android-gradle-plugin 依赖:

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.5.3'
        //添加神策分析 android-gradle-plugin 依赖
        classpath 'com.sensorsdata.analytics.android:android-gradle-plugin2:3.2.0'
    }
}
allprojects {
    repositories {
        jcenter()
    }
}
GROOVY

Sensors Analytics android-gradle-plugin 的最新版本号请参考 GitHub 更新日志

如下示例图:

1.2. 引入 SDK

 主 module build.gradle 文件中添加 com.sensorsdata.analytics.android 插件、神策分析 SDK 依赖:

apply plugin: 'com.android.application'
//添加 com.sensorsdata.analytics.android 插件
apply plugin: 'com.sensorsdata.analytics.android'

dependencies {
   //添加 Sensors Analytics SDK 依赖
   implementation 'com.sensorsdata.analytics.android:SensorsAnalyticsSDK:3.2.11'
}
GROOVY

SensorsAnalyticsSDK 的最新版本号请参考 GitHub 更新日志

如下示例图:

Android SDK 要求最低系统版本为 API 9(Android 2.3)。AutoTrack 功能要求系统最低版本为 API 14 (Android 4.0)如果 API 低于14 开启 AutoTrack 后 将不能采集 $AppStart、$AppViewScreen、$AppEnd 事件


目前,Android SDK (aar格式) 大小约为 300 KB。

2. 获取数据接收地址

数据接收地址是 SDK 上报数据的目标地址,需要使用管理员账户进行获取。

3. 初始化 SDK 并开启全埋点

一定需要在程序的入口 Application  onCreate() 中调用 SensorsDataAPI.startWithConfigOptions(SAConfigOptions) 并且在 主线程 中初始化 SDK:


// 引入神策分析 SDK
import com.sensorsdata.analytics.android.sdk.SensorsDataAPI;
import com.sensorsdata.analytics.android.sdk.SAConfigOptions;
import com.sensorsdata.analytics.android.sdk.SensorsAnalyticsAutoTrackEventType;


// 数据接收的 URL
final String SA_SERVER_URL = "YOUR_SERVER_URL";

//设置 SAConfigOptions,传入数据接收地址 SA_SERVER_URL
SAConfigOptions saConfigOptions = new SAConfigOptions(SA_SERVER_URL);

//通过 SAConfigOptions 设置神策 SDK,每个条件都非必须,开发者可根据自己实际情况设置,更多设置可参考 SAConfigOptions 类中方法注释
saConfigOptions.setAutoTrackEventType(SensorsAnalyticsAutoTrackEventType.APP_CLICK | // 开启全埋点点击事件
                SensorsAnalyticsAutoTrackEventType.APP_START |      //开启全埋点启动事件
                SensorsAnalyticsAutoTrackEventType.APP_END |        //开启全埋点退出事件
                SensorsAnalyticsAutoTrackEventType.APP_VIEW_SCREEN)     //开启全埋点浏览事件
                .enableLog(true)        //开启神策调试日志,默认关闭(调试时,可开启日志)。
                .enableTrackAppCrash();     //开启 crash 采集
//需要在主线程初始化神策 SDK
SensorsDataAPI.startWithConfigOptions(this, saConfigOptions);
JAVA

其中 YOUR_SERVER_URL 是前文中从神策分析获取的数据接收的 URL。一旦成功初始化后,则可以通过 sharedInstance 获取 SDK 实例,进行用户行为事件或属性的追踪。

注意:利用 SAConfigOptions 设置全埋点类型、开启 crash 采集时等操作时,只有 SDK 第一次初始化时有效。请勿对多个 SAConfigOptions 对象进行相关设置

4. 调试查看数据

成功初始化 SDK 并开启全埋点后,如果相应事件触发,SDK 会自动进行采集并定时发送到神策分析后台,我们可以通过下面两种方式进行数据校验和验证:

4.1. IDE 控制台查看数据

初始化 SDK 后调用 SensorsDataAPI.sharedInstance().enableLog(true); 打开 SDK 的日志输出功能,然后在 Logcat 中筛选 SA. 关键词:

埋点事件触发成功时,SDK 会输出 track event 开头的事件数据;
埋点事件触发失败时,SDK 会输出相应的错误原因;
事件数据上报成功时,SDK 会输出 valid message 字段开头的事件数据;
事件数据上报失败时,SDK 会输出 invalid message 字段开头的事件数据并输出错误原因。

4.2. 神策分析中查看已入库数据

SDK 默认每 15s 会将本地触发的事件上报到服务端进行入库,已入库的数据,可以在神策分析中进行筛选和查看.