数据采集API
1. 数据采集开关
dataCollectionEnabled
打开或关闭数据采集
参数说明
| 参数 | 参数类型 | 说明 |
|---|---|---|
enabled | BOOL | YES 打开数据采集，NO 关闭数据采集，默认 YES |
示例
无埋点 SDK 示例代码：
[[GrowingAutotracker sharedInstance] setDataCollectionEnabled:YES];
埋点 SDK 示例代码：
[[GrowingTracker sharedInstance] setDataCollectionEnabled:YES];
2. 设置登录用户 ID
setLoginUserId
当用户登录之后调用，设置登录用户 ID
如果您的 App 每次用户升级版本时无需重新登录的话，为防止用户本地缓存被清除导致的无法被识别为登录用户，建议在用户每次升级 App 版本后初次访问时重新调用 setLoginUserId 方法
参数说明
| 参数 | 参数类型 | 说明 |
|---|---|---|
userId | NSString | 长度限制大于 0 且小于等于 1000，如果大于长度 1000 将只截取前 1000 长度 |
示例
无埋点 SDK 示例代码：
[[GrowingAutotracker sharedInstance] setLoginUserId:@"123456"];
埋点 SDK 示例代码：
[[GrowingTracker sharedInstance] setLoginUserId:@"123456"];
3. 设置登录用户 Id 以及用户 Key
setLoginUserId:userKey:
适用于 ID-MAPPING，可设置 userId 的类型，存储方式与 userId 保持一致，userKey 默认为 null
支持 ID-MAPPING SDK 版本 >=3.3.0
需在初始化 SDK 时设置 configuration.idMappingEnabled = YES
示例
无埋点 SDK 示例代码：
[[GrowingAutotracker sharedInstance] setLoginUserId:@"13111111111" userKey:@"phone"];
埋点 SDK 示例代码：
[[GrowingTracker sharedInstance] setLoginUserId:@"13111111111" userKey:@"phone"];
4. 清除登录用户 ID
cleanLoginUserId
当用户登出之后调用，清除已经设置的登录用户 ID。
示例
无埋点 SDK 示例代码：
[[GrowingAutotracker sharedInstance] cleanLoginUserId];
埋点 SDK 示例代码：
[[GrowingTracker sharedInstance] cleanLoginUserId];
5. 设置用户的地理位置
setLocation
设置用户当前的地理位置，基于 WGS-84 坐标
参数说明
| 参数 | 参数类型 | 说明 |
|---|---|---|
latitude | double | 地理坐标点纬度 |
longitude | double | 地理坐标点经度 |
示例
无埋点 SDK 示例代码：
[[GrowingAutotracker sharedInstance] setLocation:39.9 longitude:116.36];
埋点 SDK 示例代码：
[[GrowingTracker sharedInstance] setLocation:39.9 longitude:116.36];
6. 清除用户的地理位置
cleanLocation
清除用户当前的地理位置
示例
无埋点 SDK 示例代码：
[[GrowingAutotracker sharedInstance] cleanLocation];
埋点 SDK 示例代码：
[[GrowingTracker sharedInstance] cleanLocation];
7. 设置埋点事件
trackCustomEvent
发送一个埋点事件；注意：在添加发送的埋点事件代码之前，需在 CDP 平台事件管理界面创建埋点事件以及关联事件属性；
如果事件属性需关联维度表，请在事件属性下关联维度表（ CDP 平台版本>= 2.1 ）
参数说明
| 参数 | 参数类型 | 说明 |
|---|---|---|
eventName | NSString | 事件名，事件标识符 |
attributes | NSDictionary<NSString, NSString> | 事件发生时所伴随的属性信息；当事件属性关联有维度表时，属性值为对应的维度表模型 ID(记录 ID)（可选） |
示例
无埋点 SDK 示例代码：
[[GrowingAutotracker sharedInstance] trackCustomEvent:@"eventName"];
[[GrowingAutotracker sharedInstance] trackCustomEvent:@"eventName" withAttributes:@{@"property": @"value"}];
// 事件属性支持List类型，注意：SDK版本>=3.3.5，CDP平台暂不支持展示
GrowingAttributesBuilder *builder = GrowingAttributesBuilder.new;
[builder setString:@"value" forKey:@"property"];
[builder setArray:@[@"value1", @"value2", @"value3"] forKey:@"property2"];
[[GrowingAutotracker sharedInstance] trackCustomEvent:@"eventName" withAttributes:builder.build];
埋点 SDK 示例代码：
[[GrowingTracker sharedInstance] trackCustomEvent:@"eventName"];
[[GrowingTracker sharedInstance] trackCustomEvent:@"eventName" withAttributes:@{@"property": @"value"}];
// 事件属性支持List类型，注意：SDK版本>=3.3.5，CDP平台暂不支持展示
GrowingAttributesBuilder *builder = GrowingAttributesBuilder.new;
[builder setString:@"value" forKey:@"property"];
[builder setArray:@[@"value1", @"value2", @"value3"] forKey:@"property2"];
[[GrowingTracker sharedInstance] trackCustomEvent:@"eventName" withAttributes:builder.build];
详细使用示例:埋点事件示例
8. 事件计时器
trackTimerStart
初始化一个事件计时器，参数为计时事件的事件名称，返回值为该事件计时器唯一标识
trackTimerPause
暂停事件计时器，参数为trackTimerStart返回的唯一标识
trackTimerResume
恢复事件计时器，参数为trackTimerStart返回的唯一标识
trackTimerEnd
停止事件计时器，参数为trackTimerStart返回的唯一标识。调用该接口会自动触发删除定时器。
removeTimer
删除事件计时器，参数为 trackTimerStart 返回的唯一标识。
该接口会将标识为 timerId 的计时器置为空。调用停止计时器接口，会自动触发该接口。注意移除时不论计时器处于什么状态，都不会发送事件。
clearTrackTimer
清除所有已经注册的事件计时器。
存在所有计时器需要清除时调用。注意移除时不论计时器处于什么状态，都不会发送事件。
注意：SDK版本>=3.4.7支持。
参数说明
| 参数 | 参数类型 | 说明 |
|---|---|---|
eventName | NSString | 事件名，事件标识符 |
attributes | NSDictionary<NSString, NSString> | 事件发生时所伴随的属性信息；当事件属性关联有维度表时，属性值为对应的维度表模型 ID(记录 ID)（可选） |
| 参数 | 参数类型 | 说明 |
|---|---|---|
timerId | NSString | 计时器唯一标识符，由trackTimerStart返回 |
示例
无埋点 SDK 示例代码：
NSString *timerId = [[GrowingAutotracker sharedInstance] trackTimerStart:@"eventName"];
[[GrowingAutotracker sharedInstance] trackTimerPause:timerId];
[[GrowingAutotracker sharedInstance] trackTimerResume:timerId];
[[GrowingAutotracker sharedInstance] trackTimerEnd:timerId];
[[GrowingAutotracker sharedInstance] trackTimerEnd:timerId withAttributes:@{@"property" : @"value"}];
[[GrowingAutotracker sharedInstance] removeTimer:timerId];
[[GrowingAutotracker sharedInstance] clearTrackTimer];
埋点 SDK 示例代码：
NSString *timerId = [[GrowingTracker sharedInstance] trackTimerStart:@"eventName"];
[[GrowingTracker sharedInstance] trackTimerPause:timerId];
[[GrowingTracker sharedInstance] trackTimerResume:timerId];
[[GrowingTracker sharedInstance] trackTimerEnd:timerId];
[[GrowingTracker sharedInstance] trackTimerEnd:timerId withAttributes:@{@"property" : @"value"}];
[[GrowingTracker sharedInstance] removeTimer:timerId];
[[GrowingTracker sharedInstance] clearTrackTimer];
trackTimerEnd时发送CUSTOM事件上报数据：
- eventName 埋点事件标识符（trackTimerStart传入）
- attributes 用户自定义事件属性（trackTimerEnd传入）
- event_duration 事件时长 （SDK内部根据timerId自动计算获取 ）
event_duration 按照秒上报，小数点精度保证到毫秒
event_duration 变量及其值会自动添加在 attributes 中
event_duration 时间统计不会计算后台时间 - eventName 对应的埋点事件需要在平台中绑定标识符为 event_duration， 且类型为小数的事件属性
9. 设置登录用户属性
setLoginUserAttributes
以登录用户的身份定义登录用户属性，用于用户信息相关分析。
参数说明
| 参数 | 参数类型 | 说明 |
|---|---|---|
attributes | NSDictionary<NSString, NSString> | 用户属性信息 |
示例
无埋点 SDK 示例代码：
[[GrowingAutotracker sharedInstance] setLoginUserAttributes:@{@"property" : @"value"}];
// 事件属性支持List类型，注意：SDK版本>=3.3.6，CDP平台暂不支持展示
GrowingAttributesBuilder *builder = GrowingAttributesBuilder.new;
[builder setString:@"value" forKey:@"property"];
[builder setArray:@[@"value1", @"value2", @"value3"] forKey:@"property2"];
[[GrowingAutotracker sharedInstance] setLoginUserAttributes:builder.build];
埋点 SDK 示例代码：
[[GrowingTracker sharedInstance] setLoginUserAttributes:@{@"property" : @"value"}];
// 事件属性支持List类型，注意：SDK版本>=3.3.6，CDP平台暂不支持展示
GrowingAttributesBuilder *builder = GrowingAttributesBuilder.new;
[builder setString:@"value" forKey:@"property"];
[builder setArray:@[@"value1", @"value2", @"value3"] forKey:@"property2"];
[[GrowingTracker sharedInstance] setLoginUserAttributes:builder.build];
详细使用示例:用户属性事件示例
10. 获取设备 ID
getDeviceId
获取设备 id，又称为匿名用户 id，SDK 自动生成用来定义唯一设备。
如果没有初始化 SDK 或者关闭采集开关可能返回值为 nil，且可能有 IO 操作。
示例
无埋点 SDK 示例代码：
[[GrowingAutotracker sharedInstance] getDeviceId];
埋点 SDK 示例代码：
[[GrowingTracker sharedInstance] getDeviceId];
11. 设置页面别名
growingPageAlias
给页面设置一个别名。
属性说明
UIViewController 分类声明的属性，设置需要在 viewDidAppear 执行之前
| 参数 | 参数类型 | 说明 |
|---|---|---|
growingPageAlias | NSString | 页面别名 |
示例
无埋点 SDK 示例代码：
- (void)viewDidLoad {
[super viewDidLoad];
...
self.growingPageAlias = @"我是一个页面别名";
...
}
12. 设置页面属性
growingPageAttributes
给当前页面设置页面属性。
注意：SDK版本>=3.4.7 且 OP平台版本>=4.0支持
属性说明
UIViewController 分类声明的属性，设置需要在 viewDidAppear 执行之前
| 参数 | 参数类型 | 说明 |
|---|---|---|
growingPageAttributes | NSDictionary<NSString *, NSString *> | 页面属性 |
示例
无埋点 SDK 示例代码：
- (void)viewDidLoad {
[super viewDidLoad];
...
self.growingPageAttributes = @{@"key": @"value"};
...
}
13. 设置忽略的页面
growingPageIgnorePolicy
被设置忽略的页面，不再触发无埋点的 page 事件。
属性说明
UIViewController 分类声明的属性，设置需要在 viewDidAppear 执行之前
| 属性 | 属性类型 | 说明 |
|---|---|---|
growingPageIgnorePolicy | GrowingIgnorePolicy | 1. GrowingIgnoreSelf 只忽略自己2. GrowingIgnoreChildren 只忽略该页面的子页面3. GrowingIgnoreAll 忽略所有，包括自己和该页面的子页面 |
示例
无埋点 SDK 示例代码：
- (void)viewDidLoad {
[super viewDidLoad];
...
self.growingPageIgnorePolicy = GrowingIgnoreChildren;
...
}
14. 设置忽略的 View
growingViewIgnorePolicy
被设置忽略的 VIew，不再触发点击、曝光等任何事件，被忽略的 WebView 也不会采集 Hybrid 的事件。
属性说明
UIView 分类声明的属性，设置需要在 viewDidAppear 执行之前
| 属性 | 属性类型 | 说明 |
|---|---|---|
growingViewIgnorePolicy | GrowingIgnorePolicy | 1. GrowingIgnoreSelf 只忽略自己2. GrowingIgnoreChildren 只忽略该页面的子页面3. GrowingIgnoreAll 忽略所有，包括自己和该页面的子页面 |
示例
无埋点 SDK 示例代码：
view.growingViewIgnorePolicy = GrowingIgnoreSelf;
15.设置采集 View 的曝光事件
growingTrackImpression
当被设置的 View 出现在屏幕内时将触发曝光事件
方法说明
UIView 分类方法
| 参数 | 参数类型 | 说明 |
|---|---|---|
eventName | NSString | 曝光的事件名 |
attributes | NSDictionary<NSString, NSString> | 曝光的事件属性 |
示例
无埋点 SDK 示例代码：
[self.view growingTrackImpression:@"eventName" attributes:@{@"property" : @"value"}];
16.停止采集 View 的曝光事件
growingStopTrackImpression
停止采集 View 的曝光事件
方法说明
UIView 分类方法
示例
无埋点 SDK 示例代码：
[self.view growingStopTrackImpression];
17.设置 View 唯一 Tag
growingUniqueTag
给 View 设置唯一的 Tag，方便点击等事件确定唯一的 View，一般用于动态布局的场景
属性说明
UIView 分类声明的属性
| 属性 | 属性类型 | 说明 |
|---|---|---|
growingUniqueTag | NSString | 需要设置的 Tag |
示例
无埋点 SDK 示例代码：
self.view.growingUniqueTag = @"我是一个特别的view";