数据采集API

---

API列表

无埋点SDK API列表

GrowingAutotracker.get().setDataCollectionEnabled(true)
GrowingAutotracker.get().setLoginUserId("userId")
GrowingAutotracker.get().setLoginUserId("userId","userKey")
GrowingAutotracker.get().cleanLoginUserId()
GrowingAutotracker.get().setLocation(20.11,20.11)
GrowingAutotracker.get().cleanLocation()
GrowingAutotracker.get().trackCustomEvent("eventName")
GrowingAutotracker.get().setLoginUserAttributes(new HashMap<>())
GrowingAutotracker.get().getDeviceId()
GrowingAutotracker.get().setPageAttributes(new android.app.Fragment(), new HashMap<>())
GrowingAutotracker.get().setPageAliasX(new androidx.fragment.app.Fragment(), "FragmentAliasName")
GrowingAutotracker.get().ignorePageX(new androidx.fragment.app.Fragment(), IgnorePolicy.IGNORE_SELF)
GrowingAutotracker.get().setPageAlias(new android.app.Fragment(), "FragmentAliasName")
GrowingAutotracker.get().ignorePage(new android.app.Fragment(), IgnorePolicy.IGNORE_SELF)
GrowingAutotracker.get().ignoreView(view, IgnorePolicy.IGNORE_SELF)
GrowingAutotracker.get().trackViewImpression(view, "ViewShowed")
GrowingAutotracker.get().stopTrackViewImpression(view)
GrowingAutotracker.get().setUniqueTag(button, "UniqueTagName")
GrowingAutotracker.get().bridgeWebView(webview)
GrowingAutotracker.get().trackTimerStart("timer")
GrowingAutotracker.get().trackTimerPause("timerId")
GrowingAutotracker.get().trackTimerResume("timerId")
GrowingAutotracker.get().trackTimerEnd("timerId")
GrowingAutotracker.get().removeTimer("timerId")
GrowingAutotracker.get().clearTrackTimer()
GrowingAutotracker.get().doDeepLinkByUrl("Your DeepLinkUrl", new DeepLinkCallback())

GrowingAutotracker.get().registerComponent(module,<config>)

埋点SDK API列表

GrowingTracker.get().setDataCollectionEnabled(true)
GrowingTracker.get().setLoginUserId("userId")
GrowingTracker.get().setLoginUserId("userId", "userKey")
GrowingTracker.get().cleanLoginUserId()
GrowingTracker.get().setLocation(20.11, 20.11)
GrowingTracker.get().cleanLocation()
GrowingTracker.get().trackCustomEvent("eventName")
GrowingTracker.get().setLoginUserAttributes(new HashMap<>())
GrowingTracker.get().setVisitorAttributes(new HashMap<>())
GrowingTracker.get().getDeviceId()
GrowingTracker.get().bridgeWebView(webview)
GrowingTracker.get().trackTimerStart("timer")
GrowingTracker.get().trackTimerPause("timerId")
GrowingTracker.get().trackTimerResume("timerId")
GrowingTracker.get().trackTimerEnd("timerId")
GrowingTracker.get().removeTimer("timerId")
GrowingTracker.get().clearTrackTimer()
GrowingTracker.get().doDeepLinkByUrl("Your DeepLinkUrl", new DeepLinkCallback())

GrowingTracker.get().registerComponent(module,<config>)

API 详细说明

1. 数据采集开关

setDataCollectionEnabled
打开或关闭数据采集

参数说明

参数	参数类型	说明
enabled	boolean	true打开数据采集，false关闭数据采集，默认 true

示例

无埋点SDK示例代码：

GrowingAutotracker.get().setDataCollectionEnabled(true)

埋点SDK示例代码：

GrowingTracker.get().setDataCollectionEnabled(true)

2. 设置登录用户ID

setLoginUserId
当用户登录之后调用，设置登录用户ID

info

支持 ID-MAPPING SDK版本 >=3.3.0 需在初始化 SDK 时设置setIdMappingEnabled为true

如果您的App每次用户升级版本时无需重新登录的话，为防止用户本地缓存被清除导致的无法被识别为登录用户，建议在用户每次升级App版本后初次访问时重新调用setLoginUserId方法

参数说明

参数	参数类型	说明
userId	String	长度限制大于0且小于等于1000，如果大于长度1000将只截取前1000长度
userKey	String	适用于ID-MAPPING,可设置 userId 的类型,可选填

示例

无埋点SDK示例代码：

GrowingAutotracker.get().setLoginUserId("112333445")
GrowingAutotracker.get().setLoginUserId("112333445","phone")

埋点SDK示例代码：

GrowingTracker.get().setLoginUserId("112333445")
GrowingTracker.get().setLoginUserId("112333445","phone")

3. 清除登录用户ID

cleanLoginUserId
当用户登出之后调用，清除已经设置的登录用户ID。

示例

无埋点SDK示例代码：

GrowingAutotracker.get().cleanLoginUserId()

埋点SDK示例代码：

GrowingTracker.get().cleanLoginUserId()

4. 设置用户的地理位置

setLocation
设置用户当前的地理位置，基于WGS-84坐标

参数说明

参数	参数类型	说明
latitude	double	地理坐标点纬度
longitude	double	地理坐标点经度

示例

无埋点SDK示例代码：

GrowingAutotracker.get().setLocation(39.9, 116.3)

埋点SDK示例代码：

GrowingTracker.get().setLocation(39.9, 116.3)

5. 清除用户的地理位置

cleanLocation
清除用户当前的地理位置

示例

无埋点SDK示例代码：

GrowingAutotracker.get().cleanLocation()

埋点SDK示例代码：

GrowingTracker.get().cleanLocation()

6. 设置埋点事件

trackCustomEvent
发送一个埋点事件；注意：在添加发送的埋点事件代码之前，需在CDP平台事件管理界面创建埋点事件以及关联事件属性；
如果事件属性需关联维度表，请在事件属性下关联维度表（ CDP平台版本>= 2.1 ）

参数说明

参数	参数类型	说明
eventName	String	事件名，事件标识符
attributes	Map<String, String>	事件发生时所伴随的属性信息；当事件属性关联有维度表时，属性值为对应的维度表模型ID(记录ID)（可选）
itemKey	String	事件发生关联的物品模型Key（可选，与itemId参数一起传入）
itemId	String	事件发生关联的物品模型ID（可选，与itemKey参数一起传入）

示例

无埋点SDK示例代码：

java

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");                                                

kotlin

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")

埋点SDK示例代码：

java

GrowingTracker.get().trackCustomEvent("registerSuccess");

Map<String, String> map = new HashMap<>();
map.put("name", "June");
map.put("age", "12");
GrowingTracker.get().trackCustomEvent("registerSuccess", map);

//不再推荐使用，请使用 ResourceItemCustomEvent.setResourceItem 代替
GrowingTracker.get().trackCustomEvent("registerSuccess", map, "key", "id");

kotlin

GrowingTracker.get().trackCustomEvent("registerSuccess")

val map: MutableMap<String, String> = HashMap()
map["name"] = "June"
map["age"] = "12"
GrowingTracker.get().trackCustomEvent("registerSuccess", map)

//不再推荐使用，请使用 ResourceItemCustomEvent.setResourceItem 代替
GrowingTracker.get().trackCustomEvent("registerSuccess", map, "key", "id")

info

详细使用示例:埋点事件示例

7. 设置登录用户属性

setLoginUserAttributes
发送登录用户属性事件，用于用户信息相关分析； 在添加发送用户属性事件代码之前，需在CDP平台用户管理界面创建用户属性。

参数说明

参数	参数类型	说明
attributes	Map<String, String>	用户属性信息

示例

无埋点SDK示例代码：

java

Map<String, String> map = new HashMap<>();
map.put("gender", "male");
map.put("age", "12");
GrowingAutotracker.get().setLoginUserAttributes(map);

kotlin

val map: MutableMap<String, String> = HashMap()
map["gender"] = "male"
map["age"] = "12"
GrowingAutotracker.get().setLoginUserAttributes(map)

埋点SDK示例代码：

java

Map<String, String> map = new HashMap<>();
map.put("gender", "male");
map.put("age", "12");
GrowingTracker.get().setLoginUserAttributes(map);

kotlin

val map: MutableMap<String, String> = HashMap()
map["gender"] = "male"
map["age"] = "12"
GrowingTracker.get().setLoginUserAttributes(map)

info

详细使用示例:用户属性事件示例

8. 获取设备ID

getDeviceId
获取设备ID，又称为匿名用户ID，SDK 自动生成用来定义唯一设备。 如果没有初始化SDK 或者关闭采集开关可能返回值为null，且可能有IO操作。

示例

无埋点SDK示例代码：

GrowingAutotracker.get().getDeviceId()

埋点SDK示例代码：

GrowingTracker.get().getDeviceId()

9. 设置页面属性

setPageAttributes, setPageAttributesSupport, setPageAttributesX
给指定页面设置属性，必须在onResume生命周期之前调用。

注意：SDK版本>=3.4.5 且 OP平台版本>=4.0支持

参数说明

参数	参数类型	说明
page	Activity / Fragment	需要设置属性的页面对象
attributes	Map<String, String>	属性信息

示例

无埋点SDK示例代码：

 @Override
 protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ...
        Map<String, String> map = new HashMap<>();
        map.put("key", "value");
        GrowingAutotracker.get().setPageAttributes(mActivity, map);
        ...

}

10. 设置页面别名

setPageAlias, setPageAliasX
给页面设置一个别名，建议设置为汉字、字母、数字和下划线的组合。为查看数据方便，请尽量对 iOS 和安卓的同功能页面取不同的名称。

参数说明

参数	参数类型	说明
page	Activity / Fragment	需要设置别名的页面对象，必须在onCreate生命周期中调用
alias	String	页面别名

示例

无埋点SDK示例代码：

GrowingAutotracker.get().setPageAlias(mActivity, "home")

11. 设置忽略的页面

ignorePage,ignorePageX
被设置忽略的页面，不再触发无埋点的page事件。

参数说明

参数	参数类型	说明
page	Activity / Fragment	需要忽略的页面对象，建议在onCreate生命周期中调用
policy	IgnorePolicy	1. IGNORE_SELF 只忽略自己 2. IGNORE_CHILD 只忽略该页面的子页面 3. IGNORE_ALL 忽略所有，包括自己和该页面的子页面

示例

无埋点SDK示例代码：

GrowingAutotracker.get().ignorePage(mActivity, IgnorePolicy.IGNORE_ALL)

12. 设置忽略的View

ignoreView
被设置忽略的View，不再触发点击、曝光等任何事件，被忽略的WebView也不会采集Hybrid的事件。

参数说明

参数	参数类型	说明
view	View	需要忽略的View对象
policy	IgnorePolicy	1. IGNORE_SELF 只忽略自己 2. IGNORE_CHILD 只忽略该View的子View 3. IGNORE_ALL 忽略所有，包括自己和该View的子View

示例

无埋点SDK示例代码：

GrowingAutotracker.get().ignoreView(view, IgnorePolicy.IGNORE_SELF)

13. 设置采集View的曝光事件

trackViewImpression
当被设置的View出现在屏幕内时将触发曝光事件

参数说明

参数	参数类型	说明
view	View	需要采集曝光事件的View对象
impressionEventName	String	曝光的事件名
attributes	Map<String, String>	曝光的事件属性

示例

无埋点SDK示例代码：

java

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);

kotlin

GrowingAutotracker.get().trackViewImpression(view, "buttonShowed")
val map: MutableMap<String, String> = HashMap()
map["gender"] = "male"
map["age"] = "12"
GrowingAutotracker.get().trackViewImpression(view, "buttonShowed", map)

14. 停止采集View的曝光事件

stopTrackViewImpression
停止采集View的曝光事件

参数说明

参数	参数类型	说明
trackedView	View	需要停止采集曝光事件的View对象

示例

无埋点SDK示例代码：

GrowingAutotracker.get().stopTrackViewImpression(trackedView)

15. 设置View唯一Tag

setUniqueTag
给View设置唯一的Tag，方便点击等事件确定唯一的View，一般用于动态布局的场景

参数说明

参数	参数类型	说明
view	View	需要设置唯一Tag的View对象
tag	String	需要设置的Tag

示例

无埋点SDK示例代码：

GrowingAutotracker.get().setUniqueTag(button, "homeTabButton")

16. Webview桥接

bridgeWebView
手动注入js到webview，用来收集webview中的数据，

info

如果使用无埋点SDK，会自动注入相关代码，不需要调用该方法

参数说明

参数	参数类型	说明
view	View	可选为 webview、ucwebview和x5webview

示例

无埋点SDK示例代码：

GrowingAutotracker.get().bridgeWebView(webview)

埋点SDK示例代码：

GrowingTracker.get().bridgeWebView(webview)

17. 事件计时器

trackTimerStart
初始化一个事件计时器，参数为计时事件的事件名称，返回值为该事件计时器唯一标识

trackTimerPause
暂停事件计时器，参数为trackTimerStart返回的唯一标识

trackTimerResume
恢复事件计时器，参数为trackTimerStart返回的唯一标识

trackTimerEnd
停止事件计时器，参数为trackTimerStart返回的唯一标识。调用该接口会自动触发删除定时器。

removeTimer
删除事件计时器，参数为 trackTimerStart 返回的唯一标识。
该接口会将标识为 timerId 的计时器置为空。调用停止计时器接口，会自动触发该接口。注意移除时不论计时器处于什么状态，都不会发送事件。

clearTrackTimer
清除所有已经注册的事件计时器。
存在所有计时器需要清除时调用。注意移除时不论计时器处于什么状态，都不会发送事件。

注意：SDK版本>=3.4.6支持。

参数说明

参数	参数类型	说明
eventName	String	事件名称，事件标识符
attributes	Map<String, String>	事件发生时所伴随的属性信息

返回值说明

参数	参数类型	说明
timerId	String	计时器唯一标识

示例

无埋点SDK示例代码：

//初始化一个事件计时器
String timerId = GrowingAutotracker.get().trackTimerStart('eventName');
//暂停事件计时器
GrowingAutotracker.get().trackTimerPause(timerId);
//恢复事件计时器
GrowingAutotracker.get().trackTimerResume(timerId);

//停止事件计时器
GrowingAutotracker.get().trackTimerEnd(timerId);
//停止事件计时器携带事件属性
GrowingAutotracker.get().trackTimerEnd(timerId, new HashMap<>());

//删除事件计时器
GrowingAutotracker.get().removeTimer(timerId);
//清除事件计时器
GrowingAutotracker.get().clearTrackTimer();

埋点SDK示例代码：

//初始化一个事件计时器
String timerId = GrowingTracker.get().trackTimerStart('eventName')
//暂停事件计时器
GrowingTracker.get().trackTimerPause(timerId);
//恢复事件计时器
GrowingTracker.get().trackTimerResume(timerId);

//停止事件计时器
GrowingTracker.get().trackTimerEnd(timerId);
//停止事件计时器携带事件属性
GrowingTracker.get().trackTimerEnd(timerId, new HashMap<>());

//删除事件计时器
GrowingTracker.get().removeTimer(timerId);
//清除事件计时器
GrowingTracker.get().clearTrackTimer();

注意

trackTimerEnd时发送CUSTOM事件上报数据：

• eventName 埋点事件标识符（trackTimerStart传入）；
• attributes 用户自定义事件属性（trackTimerEnd传入）；
• event_duration 事件时长 （SDK内部根据timerId自动计算获取 ）。
  event_duration 按照秒上报，小数点精度保证到毫秒。
  event_duration 变量及其值会自动添加在 attributes 中。
  event_duration 时间统计不会计算后台时间：
• eventName 对应的埋点事件需要在平台中绑定标识符为 event_duration， 且类型为小数的事件属性。

18. 主动触发DeepLink

doDeepLinkByUrl
调用该接口需要集成广告模块，具体集成请参考广告模块

19. 注册模块组件

registerComponent
可通过该方法手动注册SDK需要的可配置模块组件（推荐在初始化通过 Configuration 初始化时注册）。

参数说明

参数	参数类型	说明
module	LibraryGioModule	模块
config	Configuration	模块的配置类(可选参数)

示例

无埋点SDK示例代码：

GrowingAutotracker.get().registerComponent(module,<config>)

埋点SDK示例代码：

GrowingTracker.get().registerComponent(module,<config>)