Android 埋点 SDK
埋点 SDK 的目标用户是使用第三方插件开发的 APP, 比如使用 Weex、APICloud 等。在这些平台中,我们无法自动采集用户的点击事件和页面浏览事件等,需要依赖调用自定义事件和变量 API来进行数据采集。 如果您的 APP 使用 Android 原生开发,并且希望自动采集用户的点击事件、页面浏览事件等无埋点事件, 请集成 Android无埋点SDK 。
Last updated
埋点 SDK 的目标用户是使用第三方插件开发的 APP, 比如使用 Weex、APICloud 等。在这些平台中,我们无法自动采集用户的点击事件和页面浏览事件等,需要依赖调用自定义事件和变量 API来进行数据采集。 如果您的 APP 使用 Android 原生开发,并且希望自动采集用户的点击事件、页面浏览事件等无埋点事件, 请集成 Android无埋点SDK 。
Last updated
Gradle编译环境(AndroidStudio)
在module级别的build.gradle文件中添加vds-android-agent
依赖、项目ID和 URL Scheme
URL Scheme的格式是growing.xxxxxxxxxxxxxxxx,它的获取方式有两种:
新产品的 URL Scheme :登录官网 ->点击“设置”icon -> 点击“应用管理” -> 点击“新建应用”-> 选择添加Android应用 -> URL Scheme 为:growing.xxxxxxxxxxxxxxxx”中标黄字体。
现有产品的 URL Scheme :登录官网 -> 点击“设置” icon -> 点击“应用管理” -> 找到对应产品的URL Scheme。
您的项目ID获取方式是:点击“设置”icon->点击“项目配置”->即可看到您的项目ID
请将以下 GrowingIO.startWithConfiguration加在您的Application 的 onCreate 方法中
(1)请确保将代码添加在Application
的onCreate
方法中,添加到其他方法中可能导致数据不准确。
(2)其中GrowingIO.startWithConfiguration
第一个参数为Application
对象。
(3)setChannel
方法的参数定义了“自定义App渠道”这个维度的值。
如果你启用了混淆,请在你的proguard-rules.pro中加入如下代码:
如果您使用了AndResGuard,请在白名单里添加GrowingIO,如下:
添加代码之后,请先Clean项目,然后再进行编译,并在你的 Android App 安装了 SDK 后重新启动几次 App,保证行为采集数据自动发送给 GrowingIO,以便顺利完成检测。
查看数据采集发送日志,能够在Android Studio
中通过Logcat
查看GrowingIO
打印的数据发送日志,在 APP
的 Application onCreate
初始化SDK
地方添加配置。
参数说明:
参数名
类型
必填
默认值
说明
debugMode
boolean
是
false
开启GrowingIO
日志,true开启
示例代码:
实时发送数据,开启则不遵循移动网络状态下数据发送大小限制以及采集数据缓存30秒发送策略。为了方便开发者查看日志,一般和setDebugMode
一起使用。在 APP
的 Application onCreate
初始化SDK
地方添加配置。
参数说明:
参数名
类型
必填
默认值
说明
testMode
boolean
是
false
开启测试模式,true开启
示例代码:
精确采集GPS
数据,请在获取坐标后,调用接口设置位置信息。当用户下一次切换页面,或者发生点击行为时,GPS
数据会被发送回GrowingIO
。如果您不调用此接口也可以,我们会根据用户的ip
定义用户位置,能够在最终的数据分析时看到APP
用户地域分布。
参数说明:
参数名
类型
必填
默认值
说明
latitude
double
是
无
纬度
longitude
double
是
无
经度
示例代码:
对应的清除地理位置方法为 clearGeoLocation();
多进程支持,SDK
默认不支持多进程使用, 但是可以通过confiuration
进行设置支持多进程。 在Application onCreate
中初始化SDK代码块中配置。
参数说明:
参数名
类型
必填
默认值
说明
isMultiprocess
boolean
是
false
开启多进程数据采集
示例代码:
接口名称
含义
disableDataCollect()
遵守欧洲联盟出台的通用数据保护条例,用户不授权,不采集用户数据
enableDataCollect()
遵守欧洲联盟出台的通用数据保护条例,用户授权,采集用户数据
通过获取回调参数,GrowingIO SDK将会传递指定活动页面参数至您的App,请根据此参数和业务场景,执行相关的交互。
在 GrowingIO SDK 代码初始化部分配置。
返回值说明:
返回值名称
类型
说明
params
Map<String,String>
自定义参数,您自定义的键值对
status
int
DeeplinkCallback.SUCCESS :自定义参数获取成功; DeeplinkCallback.PARSE_ERROR :解析异常;DeeplinkCallback.ILLEGAL_URI :非法URI; DeeplinkCallback.NO_QUERY : 自定义参数为空。
示例代码:
发送一个自定义事件。在添加所需要发送的事件代码之前,需要在打点管理用户界面配置事件以及事件级变量。
参数说明:
参数名称
参数类型
必填
说明
eventId
String
是
事件标识符
number
Number
否
事件的数值,没有number参数时,事件默认加一;
当出现number参数时,事件自增number的数值
eventLevelVariable
JSONObject
否
事件发生时所伴随的维度信息
参数限制条件:
参数违反以下条件将不发送数据,SDK 2.4.0
以上能够在 Log 日志中查看对应报错,之下版本无提示信息。调用后请关注日志,查看数据发送是否成功,事件类型t
为cstm
。
参数名称
限制条件
eventId
非空,长度限制小于等于50;
SDK 2.4.0
以下版本不支持中文,仅支持 0 到 9、a 到 z 以及下划线,并且不能以数字开头。
number
非空。
eventLevelVariable
非空,长度限制小于等于100(eventLevelVariable.length()<=100
);
eventLevelVariable
内部不允许含有JSONObject
或者JSONArray;
key
长度限制小于等于50,value
长度限制小等于1000,值不能为空串,也就是""。
示例代码:
检验数据发送日志示例:
注意 t
等于 cstm
字段,表示自定义事件发送成功,只需注意 var
、n
、num
字段,其它字段无需仔细验证。
转化变量是一种非常强大的变量类型,主要是为了归因而用,比如访问渠道、站外搜索关键词、站内搜索关键词等等。在 GrowingIO 里面可以定制变量的归因方式和持久性范围。
发送一个转化信息用于高级归因分析,在添加代码之前必须在打点管理界面上声明转化变量。
参数说明:
参数名称
参数类型
必填
说明
key
String
否
转化变量的标识符
value
String
否
转化变量的值
conversionVariables
JSONObject
否
转化变量用于高级归因分析
参数限制条件:
参数名称
限制条件
key
非空,长度限制小于等于50。
value
非空,长度限制小于等于1000。
conversionVariables
非空,长度限制小于等于100(conversionVariables.length()<=100
);
conversionVariables
内部不允许含有JSONObject
或者JSONArray
;
key
长度限制小于等于50,value
长度限制小等于1000。
示例代码:
检验数据发送日志示例:
注意 t
等于evar
字段,表示转化事件发送成功,只需注意 var
字段,其它字段无需仔细验证。
发送用户信息用于用户信息相关分析,在添加代码之前必须在打点管理界面上声明用户变量。
参数说明:
参数名称
参数类型
必填
说明
key
String
否
用户变量的标识符
value
String
否
用户变量的值
peopleVariables
JSONObject
否
用户变量用于用户信息相关的分析
参数限制条件:
参数名称
限制条件
key
非空,长度限制小于等于50。
value
非空,长度限制小于等于1000。
peopleVariables
非空,长度限制小于等于100(peopleVariables.length()<=100
);
peopleVariables
内部不允许含有JSONObject
或者JSONArray
;
key
长度限制小于等于50,value
长度限制小等于1000,值不能为空串,也就是""。
示例代码:
检验数据发送日志示例:
注意 t
等于ppl
字段,表示用户变量发送成功,只需注意 var
字段,其它字段无需仔细验证。
当用户登录之后调用setUserId API,设置登录用户ID。
参数说明:
参数名称
参数类型
必填
说明
userId
String
是
登录用户Id,长度限制小于等于1000;
如果值为空则清空了登录用户变量,不建议这么用,
请使用 clearUserId 清除登录用户变量。
示例代码:
注:您的 App 每次用户升级版本时无需重新登录的话,建议在用户每次升级App 版本后初次访问时重新调用上述 setUserId 方法。
当用户登出之后调用clearUserId,清除已经设置的登录用户ID。
示例代码:
2.4.0以上版本支持
当用户未登录时,定义用户属性变量,也可用于A/B测试上传标签。
参数说明:
参数名称
参数类型
必填
说明
visitorVar
JSONObject
是
不可使用嵌套的JSONObject
对象,即为JSONObject中不可以放入JSONObject
或者JSONArray
;
key 长度限制小于等于50,value长度限制小等于1000,值不能为空串,也就是""。
示例代码:
检验数据发送日志示例:
注意 t
等于vstr
字段,表示访问用户变量发送成功,其它字段无需仔细验证。
验证 SDK 的采集事件数据发送至关重要,数据采集是数据分析的基础,保证了数据采集的精准才能帮助您做出正确的数据分析。
强烈建议开发者验证 GrowingIO SDK 的数据发送,如果有任何问题,及时反馈技术支持,我们会一直努力增强我们的采集能力,给您更好的服务。
GrowingIO 的数据采集分为自动采集和用户自定义事件和变量两种方式采集移动端APP,也就是通常所说的无埋点和埋点。下面将分别介绍这两种方式GrowingIO定义的采集事件类型。
事件类型
含义
发送时机
activate
激活
当APP首次激活打开时
vst
应用访问
1.冷启动发送
2.切换用户发送
3.默认APP进入后台30秒以后再次打开会发送
reengage
DeepLink唤醒事件
通过扫描 DeepLink 二维码唤醒 APP 后发送
事件类型
含义
发送时机
cstm
自定义事件触发
evar
转化变量触发
ppl
设置用户变量
vstr
设置访问用户变量
GrowingIO 提供了初始化配置项 API 和运行时 API 来自定义 SDK 的采集,满足不同场景的定制采集。同一种含义的API,只需要调用一次即可,比如您关闭SDK的采集功能,可以在初始化中配置,也可以在运行时配置,只需调用一次相关API即可。
GrowingIO 埋点 SDK 仅自动采集设备信息和您埋点内容数据,对比无埋点 SDK ,埋点 SDK 少很多 API, 请勿在埋点 SDK 中调用无埋点 SDK 接口。
初始化配置项均在Application
的onCreate
方法中 SDK 初始化代码块中设置,下面将分类并描述含义。
初始化配置项API
默认值
说明
setTestMode
false
在Logcat中输出采集日志
setDebugMode
false
实时发送数据,开启则不遵循移动网络状态下数据发送大小默认 3M 限制以及采集数据缓存30秒发送策略。
为了方便开发者查看日志,一般和setTestMode
一起使用。
setChannel
无
设置渠道
初始化配置项API
默认值
说明
setDeeplinkCallback
无
DeepLink 回调接口,获得自定义参数以便跳转对应 APP页 面
setMutiprocess
false
使用了多进程必须配置,自定义事件和变量值才会多进程共享
初始化配置项API
默认值
说明
setDisabled
false
SDK 是否采集数据,设置为true
时不采集数据
setSampling
1
采样率[0.01~1],若设置sampling = 0.01,则 1% 的设备会被采集数据,每次启动会根据用户设置的采样率判断设备是否在采集的范围之内,使用之前请咨询技术支持
setSessionInterval
30 * 1000
在后台停留时长超过此值,则产生新的sessionId
,发送visit
事件。
setFlushInterval
30 * 1000
数据刷新的最长时间间隔,默认30 秒 。如果距离上次发送数据事件超过此时间则发送事件
setCellularDataLimit
3 * 1024 * 1024
一天的时间之内,在移动蜂窝网下的数据最大传输量,默认3M。
setBulkSize
300
如果数据库存储数据条数大于等于bulkSize
,则马上发送数据。
GrowingIO 为 APP 提供运行时随意调用的 API,使用方法如下:
GrowingIO 所有 API 都需要在主线程调用。
运行时API
说明
setGeoLocation
设置经纬度,并在 vst 事件中发送,Android SDK 暂时没办法自动获取GPS
数据,如果您要采集GPS
数据,需要在您的App每次获取完GPS
数据之后,通过该API
告知 SDK。如果您不设置,我们默认使用用户IP
的Location。
clearGeoLocation
清空经纬度
运行时API
说明
disableDataCollect
遵守欧洲联盟出台的通用数据保护条例,用户不授权,不采集用户数据
enableDataCollect
遵守欧洲联盟出台的通用数据保护条例,用户授权,采集用户数据
disable
GrowingIO 停止采集
resume
GrowingIO 恢复采集
stop
GrowingIO 停止采集,可以不在主线程调用
getSessionId
得到 session id
getDeviceId
获取设备id,对应数据采集的u
字段,又称为匿名用户id
,用来定义一台设备,SDK 自动生成。
在 Android SDK 文档中描述的更详细,请点击查看。
自定义事件和变量API
说明
track
发送自定义事件,对应cstm
事件
setEvar
发送转化变量,对应evar
事件
setPeopleVariable
发送用户变量,对应ppl
事件
setUserId
设置登录用户ID,对应cs1
字段
clearUserId
清除登录用户ID
setVisitor
设置访问用户变量,对应vstr
事件
把URL Scheme添加到您的项目,以便在使用 的时候通过 Deep Link 方式唤醒您的程序。将该产品的 URLScheme 添加到你的 AndroidManifest.xml 中的 LAUNCHER Activity下。例如:
您的APP或网页在集成了 GrowingIO 的 SDK 之后,它将会自动地为您采集一系列用户行为数据,进行。除自动收集的用户行为数据(或称为无埋点数据)之外,GrowingIO 还提供了多种 API 接口,供您上传一些和变量,下面介绍自定义事件和变量 API 使用方法,后文简称埋点事件API。
调用后发送
调用后发送
调用后发送
调用后发送