数据采集API
通过 GrowingAutotracker 类可以调用 SDK 中所有开放的API，通过这些API可以进行更改配置，设置参数等操作。
GrowingAutotracker.get().setDataCollectionEnabled(true)GrowingAutotracker.get().setLoginUserId("userId")GrowingAutotracker.get().setLoginUserId("zhangshan","username")GrowingAutotracker.get().cleanLoginUserId()GrowingAutotracker.get().setLocation(20.11,20.11)GrowingAutotracker.get().cleanLocation()GrowingAutotracker.get().trackCustomEvent("registerSuccess")GrowingAutotracker.get().setLoginUserAttributes(new HashMap<>())GrowingAutotracker.get().setVisitorAttributes(new HashMap<>())GrowingAutotracker.get().getDeviceId()GrowingAutotracker.get().setPageAliasX(new androidx.fragment.app.Fragment(),"TestFragment")GrowingAutotracker.get().ignorePageX(new androidx.fragment.app.Fragment(),IgnorePolicy.IGNORE_SELF)GrowingAutotracker.get().setPageAlias(new android.app.Fragment(),"TestFragment")GrowingAutotracker.get().ignorePage(new android.app.Fragment(),IgnorePolicy.IGNORE_SELF)GrowingAutotracker.get().ignoreView(view,IgnorePolicy.IGNORE_SELF)GrowingAutotracker.get().trackViewImpression(view,"buttonShowed")GrowingAutotracker.get().stopTrackViewImpression(view)GrowingAutotracker.get().setUniqueTag(button, "homeTabButton")GrowingAutotracker.get().bridgeWebView(webview)GrowingAutotracker.get().registerComponent(module)
打开或关闭数据采集
参数 | 参数类型 | 是否必传 | 说明 |
|
| 否 |
|
GrowingAutotracker.get().setDataCollectionEnabled(true)
当用户登录之后调用setLoginUserId API，设置登录用户ID
参数 | 参数类型 | 是否必传 | 说明 |
|
| 是 | 长度限制大于0且小于等于1000，如果大于长度1000将只截取前1000长度 |
|
| 否 | 适用于ID-MAPPING,可选填 |
GrowingAutotracker.get().setLoginUserId("张三")GrowingAutotracker.get().setLoginUserId("111011101101","phone")
当用户登出之后调用cleanLoginUserId，清除已经设置的登录用户ID。
GrowingAutotracker.get().cleanLoginUserId()
设置用户当前的地理位置，基于WGS-84坐标
参数 | 参数类型 | 说明 |
|
| 地理坐标点纬度 |
|
| 地理坐标点经度 |
GrowingAutotracker.get().setLocation(39.9, 116.3)
清除用户当前的地理位置
GrowingAutotracker.get().cleanLocation()
发送一个自定义事件。在添加所需要发送的事件代码之前，需要在事件管理用户界面配置事件以及事件级变量。
参数 | 参数类型 | 是否必传 | 说明 |
|
| 是 | 事件名，事件标识符 |
|
| 否 | 事件发生时所伴随的维度信息（可选） |
|
| 否 | 事件发生关联的物品模型Key（可选，与itemId参数一起传入） |
|
| 否 | 事件发生关联的物品模型ID（可选，与itemKey参数一起传入） |
GrowingAutotracker.get().trackCustomEvent("registerSuccess");Map<String, String> map = new HashMap<>();map.put("name", "June");map.put("age", "12");GrowingAutotracker.get().trackCustomEvent("registerSuccess", map);GrowingAutotracker.get().trackCustomEvent("registerSuccess", map, "key", "id");
GrowingAutotracker.get().trackCustomEvent("registerSuccess")val map: MutableMap<String, String> = HashMap()map["name"] = "June"map["age"] = "12"GrowingAutotracker.get().trackCustomEvent("registerSuccess", map)GrowingAutotracker.get().trackCustomEvent("registerSuccess", map, "key", "id")
以登录用户的身份定义用户属性变量，用于用户信息相关分析。
参数 | 参数类型 | 是否必传 | 说明 |
|
| 是 | 用户属性信息 |
Map<String, String> map = new HashMap<>();map.put("gender", "male");map.put("age", "12");GrowingAutotracker.get().setLoginUserAttributes(map);
val map: MutableMap<String, String> = HashMap()map["gender"] = "male"map["age"] = "12"GrowingAutotracker.get().setLoginUserAttributes(map)
获取设备id，又称为匿名用户id，SDK 自动生成用来定义唯一设备。 如果没有初始化SDK 或者关闭采集开关可能返回值为null，且可能有IO操作。
GrowingTracker.get().getDeviceId()
给页面设置一个别名，建议设置为汉字、字母、数字和下划线的组合。为查看数据方便，请尽量对 iOS 和安卓的同功能页面取不同的名称。
参数 | 参数类型 | 是否必传 | 说明 |
|
| 是 | 需要设置别名的页面对象，必须在 |
|
| 是 | 页面别名 |
GrowingAutotracker.get().setPageAlias(mActivity, "home")
被设置忽略的页面，不再触发无埋点的page事件。
参数 | 参数类型 | 说明 |
|
| 需要忽略的页面对象，建议在 |
|
| 1. |
GrowingAutotracker.get().ignorePage(mActivity, IgnorePolicy.IGNORE_ALL)
被设置忽略的VIew，不再触发点击、曝光等任何事件，被忽略的WebView也不会采集Hybrid的事件。
参数 | 参数类型 | 说明 |
|
| 需要忽略的View对象 |
|
| 1. |
GrowingAutotracker.get().ignoreView(view, IgnorePolicy.IGNORE_SELF)
当被设置的View出现在屏幕内时将触发曝光事件
参数 | 参数类型 | 说明 |
|
| 需要采集曝光事件的View对象 |
|
| 曝光的事件名 |
|
| 曝光的事件属性 |
GrowingAutotracker.get().trackViewImpression(view, "buttonShowed");Map<String, String> map = new HashMap<>();map.put("color", "red");map.put("name", "home");GrowingAutotracker.get().trackViewImpression(view, "buttonShowed", map);
GrowingAutotracker.get().trackViewImpression(view, "buttonShowed")val map: MutableMap<String, String> = HashMap()map["gender"] = "male"map["age"] = "12"GrowingAutotracker.get().trackViewImpression(view, "buttonShowed", map)
停止采集View的曝光事件
参数 | 参数类型 | 说明 |
|
| 需要停止采集曝光事件的View对象 |
GrowingAutotracker.get().stopTrackViewImpression(trackedView)
给View设置唯一的Tag，方便点击等事件确定唯一的View，一般用于动态布局的场景
参数 | 参数类型 | 说明 |
|
| 需要设置唯一Tag的View对象 |
|
| 需要设置的Tag |
GrowingAutotracker.get().setUniqueTag(button, "homeTabButton")
如果集成的是埋点SDK，需要手动注入js到webview, 用来与webview中Web JS SDK 做数据打通；如果集成的是无埋点SDK 则无需调用，SDK 已实现该功能
参数 | 参数类型 | 是否必传 | 说明 |
|
| 是 | 可选为 |
GrowingTracker.get().bridgeWebView(webview)
可通过该方法手动注册SDK需要的可配置模块组件
参数 | 参数类型 | 说明 |
|
| 模块 |
GrowingAutotracker.get().registerComponent(module)