帮助文档
搜索文档…
埋点 SDK 集成
埋点 SDK 只自动采集用户访问事件,需要开发同学调用相应埋点 API 采集自定义事件。
埋点 SDK 的目标用户是使用第三方插件开发的 APP, 比如使用 Weex、APICloud 等。在这些平台中,我们无法自动采集用户的点击事件和页面浏览事件等,需要依赖调用自定义事件和变量 API 来进行数据采集。
如果您的 APP 使用 Android 原生开发,并且希望自动采集用户的点击事件、页面浏览事件等无埋点事件, 请集成 Android 无埋点SDK 。
前提条件
    获取项目 ID,获取方法请参考"项目管理 > 项目概览 > 查看项目基本信息"。
    获取 URL Scheme,在 GrowingIO 平台创建对应的应用时会生成 URL Scheme。请参考创建应用

1. 添加跟踪代码

Gradle 编译环境:Android Studio
App 适配最低系统版本:Android 4.2 及以上

1. 添加依赖

2.9.0 版本后仓库从 JCenter 迁移到了 Maven Central, 请使用 mavenCentral() 替换 jcenter()
在 module 级别的 build.gradle 文件中添加vds-android-agent依赖、项目 ID 和 URL Scheme。
代码示例:
1
android {
2
defaultConfig {
3
resValue("string", "growingio_project_id", "您的项目ID")
4
resValue("string", "growingio_url_scheme", "您的URL Scheme")
5
}
6
}
7
dependencies {
8
//GrowingIO 埋点 SDK
9
implementation 'com.growingio.android:vds-android-agent:track-2.9.4'
10
}
Copied!

2. 添加URL cheme和应用权限

在当前Android项目的配置文件AndroidManifest.xml 中的 LAUNCHER Activity 下添加URL Scheme,以便在使用Mobile Debugger的时候通过DeepLink方式唤醒您的程序。
代码示例:
1
<?xml version="1.0" encoding="utf-8"?>
2
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
3
package="com.example.growingio.testdemo">
4
5
<!-- GIO 需要的权限 -->
6
<uses-permission android:name="android.permission.INTERNET" />
7
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
8
<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />
9
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
10
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
11
<!-- GIO 需要的权限 -->
12
13
<!--请注意<application/>标签中的name属性值(这里为android:name=".MyApplication")必须为您的Application类-->
14
<application
15
android:allowBackup="true"
16
android:icon="@mipmap/ic_launcher"
17
android:label="@string/app_name"
18
android:roundIcon="@mipmap/ic_launcher_round"
19
android:supportsRtl="true"
20
android:name=".MyApplication"
21
android:theme="@style/AppTheme">
22
<activity android:name=".MainActivity">
23
<intent-filter>
24
<action android:name="android.intent.action.MAIN" />
25
26
<category android:name="android.intent.category.LAUNCHER" />
27
</intent-filter>
28
<!--请添加这里的整个 intent-filter 区块,并确保其中只有一个 data 字段-->
29
<intent-filter>
30
<data android:scheme="growing.您的URL Scheme" />
31
<action android:name="android.intent.action.VIEW" />
32
33
<category android:name="android.intent.category.DEFAULT" />
34
<category android:name="android.intent.category.BROWSABLE" />
35
</intent-filter>
36
<!--请添加这里的整个 intent-filter 区块,并确保其中只有一个 data 字段-->
37
</activity>
38
</application>
39
40
</manifest>
Copied!
请添加一整个 intent-filter 区块,并确保其中只有一个 data 字段。

3. SDK初始化配置

请将以下 GrowingIO.startWithConfiguration加在您的Application 的 onCreate 方法中
代码示例
Java
Kotlin
1
public class MyApplication extends Application {
2
@Override
3
public void onCreate() {
4
super.onCreate();
5
GrowingIO.startWithConfiguration(this, new Configuration()
6
.setChannel("XXX应用商店")
7
);
8
}
9
}
Copied!
1
class MyApplication : Application() {
2
override fun onCreate() {
3
super.onCreate()
4
GrowingIO.startWithConfiguration(
5
this, Configuration()
6
.setChannel("XXX应用商店")
7
)
8
}
9
}
Copied!
    1.
    请确保将代码添加在ApplicationonCreate方法中,添加到其他方法中可能导致数据不准确。
    2.
    其中GrowingIO.startWithConfiguration第一个参数为ApplicationContext对象。
    3.
    setChannel方法的参数定义了“自定义App渠道”这个维度的值。

4. 代码混淆

如果你启用了混淆,请在你的proguard-rules.pro中加入如下代码:
SDK 2.6.0 更新了混淆文件,前后混淆文件内容截然不同,请注意更新。
1
-keep class com.growingio.** {
2
*;
3
}
4
-dontwarn com.growingio.**
5
-keepnames class * extends android.view.View
6
-keepnames class * extends android.app.Fragment
7
-keepnames class * extends android.support.v4.app.Fragment
8
-keepnames class * extends androidx.fragment.app.Fragment
9
-keep class android.support.v4.view.ViewPager{
10
*;
11
}
12
-keep class android.support.v4.view.ViewPager$**{
13
*;
14
}
15
-keep class androidx.viewpager.widget.ViewPager{
16
*;
17
}
18
-keep class androidx.viewpager.widget.ViewPager$**{
19
*;
20
}
Copied!
如果您使用了AndRestGuard,请在白名单里添加GrowingIO。
代码示例:
1
R.string.growingio*
Copied!

5 设置SDK异常上传开关

SDK会收集SDK内部异常上报服务端,方便开发更好的追踪SDK的问题,和完善SDK的功能。如果您不想帮助我们产品完善功能,或者和您的crash收集框架有冲突,您可以选择关闭此功能。

5.1 setUploadExceptionEnable

异常消息上报开关
1
setUploadExceptionEnable(boolean uploadExceptionEnable)
Copied!

5.2 参数说明

参数名
类型
必填
默认值
说明
uploadExceptionEnable
boolean
true
开关SDK异常上传功能,true开启,false关闭

5.3 代码示例

Java
Kotlin
1
GrowingIO.startWithConfiguration(this, Configuration()
2
.setUploadExceptionEnable(true)
3
);
Copied!
1
GrowingIO.startWithConfiguration(this, Configuration()
2
.setUploadExceptionEnable(true)
3
)
Copied!

2. 重要配置

1. 设置Debug模式(setDebugMode)

查看数据采集发送日志,能够在Android Studio中通过Logcat查看GrowingIO打印的数据发送日志。
在App的Application onCrate初始化SDK位置添加配置。
1
setDebugMode(boolean debugMode);
Copied!
参数说明
参数
类型
是否必填
说明
debugMode
boolean
开启GrowingIO日志,true开始,默认false
示例代码
Java
Kotlin
1
GrowingIO.startWithConfiguration(this,new Configuration()
2
//BuildConfig.DEBUG 这样配置就不会上线忘记关闭
3
.setDebugMode(BuildConfig.DEBUG)
4
...
5
);
Copied!
1
GrowingIO.startWithConfiguration(
2
this, Configuration() //BuildConfig.DEBUG 这样配置就不会上线忘记关闭
3
.setDebugMode(BuildConfig.DEBUG)
4
)
Copied!

2. 设置Test模式(setTestMode)

实时发送数据,开启则不遵循移动网络状态下数据发送大小限制以及采集数据缓存30秒发送策略。为了方便开发者查看日志,一般和setDebugMode一起使用。
在App的Application onCrate初始化SDK位置添加配置。
1
setTestMode(boolean testMode);
Copied!
参数说明
参数
类型
是否必填
说明
testMode
boolean
开启测试模式,true开启,默认false
示例代码
Java
Kotlin
1
GrowingIO.startWithConfiguration(this,new Configuration()
2
//BuildConfig.DEBUG 这样配置就不会上线忘记关闭
3
.setTestMode(BuildConfig.DEBUG)
4
...
5
);
Copied!
1
GrowingIO.startWithConfiguration(
2
this, Configuration() //BuildConfig.DEBUG 这样配置就不会上线忘记关闭
3
.setTestMode(BuildConfig.DEBUG)
4
)
Copied!

3. 采集GPS数据(setGeoLocation)

精确采集GPS数据,请在获取坐标后,调用接口设置位置信息。当用户下一次切换页面,或者发生点击行为时,GPS数据会被发送回GrowingIO
如果您不调用此接口也可以,我们会根据用户的ip定义用户位置,能够在最终的数据分析时看到APP用户地域分布。
1
GrowingIO.getInstance().setGeoLocation(double latitude,double longitude);
Copied!
参数说明
参数
类型
是否必传
说明
latitude
double
纬度
longitude
double
经度
示例代码
1
//北京的经纬度
2
GrowingIO.getInstance().setGeoLocation(39.9046900000,116.4071700000);
Copied!
对应的清除地理位置的方法为 clearGeoLocation();

4. 多进程支持(setMutiprocess)

多进程支持,SDK默认不支持多进程使用, 但是可以通过confiuration进行设置支持多进程。 在Application onCreate 中初始化SDK代码块中配置。
1
//支持多进程数据采集
2
setMutiprocess(boolean setMutiprocess);
Copied!
参数说明
参数
类型
是否必填
说明
isMultiprocess
boolean
开启多进程数据采集。默认值false
示例代码:
Java
Kotlin
1
GrowingIO.startWithConfiguration(this, new Configuration()
2
.setMutiprocess(true)
3
);
Copied!
1
GrowingIO.startWithConfiguration(
2
this, Configuration()
3
.setMutiprocess(true)
4
)
Copied!
    1.
    为什么不默认支持多进程?
    跨进程通信是一个相对较慢的过程, 默认不开启, 可以满足大部分用户的要求。
      1.
      哪些进程需要初始化SDK?
    需要使用SDK功能的进程需要初始化SDK, 所有的UI进程 + 部分Service进程(如果这些进程中涉及手动埋点)。

5. GDPR数据采集开关

SDK版本支持:2.3.2及以上
接口
含义
disableDataCollect()
遵守欧洲联盟出台的通用数据保护条例,用户不授权,不采集用户数据
enableDataCollect()
遵守欧洲联盟出台的通用数据保护条例,用户授权,采集用户数据
​通过获取回调参数,GrowingIO SDK将会传递指定活动页面参数至您的App,请根据此参数和业务场景,执行相关的交互。
在 GrowingIO SDK 代码初始化部分配置。
Java
Kotlin
1
GrowingIO.startWithConfiguration(this, new Configuration()
2
.setDeeplinkCallback(new DeeplinkCallback() {
3
@Override
4
public void onReceive(Map<String, String> params, int status, long time) {
5
// 这里接收您的参数,匹配键值对,跳转指定 APP 内页面
6
}
7
})
8
);
Copied!
1
GrowingIO.startWithConfiguration(
2
this, Configuration()
3
.setDeeplinkCallback(object : DeeplinkCallback {
4
5
override fun onReceive(params: MutableMap<String, String>?, status: Int, longTime: Long) {
6
// 这里接收您的参数,匹配键值对,跳转指定 APP 内页面
7
}
8
})
9
)
Copied!
返回值说明
返回值名称
类型
说明
params
Map<string,string>
自定义参数,您自定义的键值对
status
int
DeeplinkCallback.SUCCESS :自定义参数获取成功; DeeplinkCallback.PARSE_ERROR :解析异常;DeeplinkCallback.ILLEGAL_URI :非法URI; DeeplinkCallback.NO_QUERY : 自定义参数为空。
示例代码
Java
Kotlin
1
GrowingIO.startWithConfiguration(this, new Configuration()
2
.setDeeplinkCallback(new DeeplinkCallback() {
3
@Override
4
public void onReceive(Map<String, String> params, int status,long time) {
5
if (status == DeeplinkCallback.SUCCESS) {
6
//获得您的自定义参数,处理您的相关逻辑
7
Log.d("TestApplication", "DeepLink 参数获取成功,params" + params.toString());
8
}
9
}
10
})
11
);
Copied!
1
GrowingIO.startWithConfiguration(this, Configuration()
2
.setDeeplinkCallback { params, status, time ->
3
if (status == DeeplinkCallback.SUCCESS) {
4
//获得您的自定义参数,处理您的相关逻辑
5
Log.d("TestApplication", "DeepLink 参数获取成功,params$params")
6
}
7
}
8
)
Copied!

3. 自定义数据上传

GrowingIO 提供多种 API 接口,供您上传一些自定义的数据指标及维度 ,请参考Android SDK API > 自定义数上传API

4. 创建应用

添加代码之后,请先Clean项目,然后再进行编译,并在你的 Android App 安装了 SDK 后重新启动几次 App,保证行为采集数据自动发送给 GrowingIO,以便顺利完成检测。
在GrowingIO平台的应用创建页面继续完成应用创建的数据检测,检测成功后应用创建成功。

5. 验证SDK是否正常采集数据

了解GrowingIO平台数据采集类型请参考数据模型
GrowingIO为您提供多种验证SDK是否正常采集数据的方式:
方式一:Mobile Debugger​
方式二:在SDK中设置了Debug模式后,在IDE编译器控制台查看数据采集日志。
方式三:数据校验
最近更新 2mo ago