自动采集

iOS SDK 支持包括安装、启动、关闭、页面浏览、元素点击等在内事件的自动采集。

# 1. 介绍

GravityEngineSDK 提供自动化收集数据的接口，您可根据业务需求自行选择需要自动收集的数据。

目前支持的自动采集事件类型有：

• 安装事件：记录 APP 被安装的行为
• 启动事件：包括打开 APP 和从后台打开 APP
• 关闭事件：包括关闭 APP 和 App 进入后台，同时收集启动的时长
• 浏览事件：用户在 APP 中浏览页面（原生页面）
• 点击事件：用户在 APP 中点击控件
• 崩溃事件：APP 发生崩溃时记录崩溃信息

接下来将会对每种类型的自采集事件做详细介绍。

# 2. 开启自动采集

您可以调用enableAutoTrack，打开自动采集功能：

[[GravityEngineSDK startWithConfig:config]enableAutoTrack:
GravityEngineEventTypeAppStart |//APP 启动事件，记录 APP 启动或从后台恢复
GravityEngineEventTypeAppInstall |//APP 安装，记录 APP 被安装的日志
GravityEngineEventTypeAppEnd |//APP 关闭事件，记录 APP 调入后台
GravityEngineEventTypeAppViewScreen |//APP 浏览页面事件
GravityEngineEventTypeAppClick |//APP 点击控件事件
GravityEngineEventTypeAppViewCrash];//APP 崩溃事件

# 3. 详细介绍

# 3.1 安装事件

APP 安装事件将会记录 APP 的实际安装，在 APP 启动时上报，事件触发时间是 APP 安装后首次启动的时间，APP 升级并不会触发安装事件，而删除重装后会上报安装事件。

• 事件英文名：$AppInstall

# 3.2 启动事件

APP 启动事件将会在用户开启 APP，或从后台唤醒 APP 时触发。

• 事件英文名：$AppStart
• 预置属性：$resume_from_background，布尔型，表示 APP 是用户开启还是从后台唤醒，取值为 true 表示从后台唤醒，false 为直接开启。

# 3.3 关闭事件

APP 关闭事件将会在用户关闭 APP，或将 APP 调至后台时触发。

• 事件英文名：$AppEnd
• 预置属性：$event_duration，数值型，表示该次 APP 访问（自启动至结束）的时长，单位是秒。

# 3.4 浏览页面事件

APP 浏览页面事件将会在用户切换页面（View Controller）时，将会触发浏览页面事件。

• 事件英文名：$AppView
• 预置属性：
  • $screen_name，字符串型，为 View Controller 的类名
  • $title，字符串型，为 View Controller 的标题，取值为 controller.navigationItem.title 属性的值

页面浏览事件中可以加入其它属性以扩展其分析价值，以下是自定义浏览页面事件的属性的方法

# 3.4.1 自定义页面浏览事件的属性

对于继承自 UIViewController 的 View Controller，您可以通过实现 Protocol 来设置属性以及页面的 URL 信息，SDK 将会自动将 getTrackProperties:的返回值加入到该 View Controller 的 APP 浏览页面事件中；另外 getScreenUrl:的返回值将会作为该页面的 URL Schema，当触发该页面的浏览事件时，将会加入预置属性$url，取值即为当前页面的 URL Schema，同时 SDK 会取跳转前页面的 URL Schema，如果能取到则会加入到预置属性$referrer 中则为前向地址。

@interface MYController : UITableViewController<GEScreenAutoTracker>
@end

@implementation MYController

- (NSDictionary *)getTrackProperties {
    return @{@"PageName" : @"商品详情页", @"ProductId" : @12345};
}

- (NSString *)getScreenUrl {
    return @"APP://test";
}
@end

相关预置属性：

• $url，字符串型，表示浏览页面的 URL
• $referrer，字符串型，表示页面跳转前页面的 URL

# 3.5 APP 控件点击事件

APP 控件点击事件将会在用户点击控件时触发

• 事件英文名：$AppClick
• 预置属性：
  • $screen_name，字符串型，为控件所在 View Controller 的类名
  • $element_content，字符串型，为控件的内容
  • $element_type，字符串型，为控件的类型
  • $element_position，字符串型，当控件存在 position 时才会上传

对于页面上控件的点击事件，有以下多种方式来设置更多属性，以扩展其分析价值：

# 3.5.1 置控件元素 ID

您可以为页面上的元素(View)设置元素 ID 以区分不同意义的元素，可以使用如下方法设置元素 ID：

self.table1.gravityEngineViewID = @"testtable1";

此时table1的点击事件中会加入预置属性$element_id，取值即为此处的传入值

• 相关预置属性：$element_id，字符串型，表示该元素的自定义 ID

# 3.5.2 自定义控件点击事件的属性

对于大多数控件，可以直接使用 gravityEngineViewProperties 设置自定义属性：

self.table1.gravityEngineViewProperties = @{@"key1":@"value1"};

# 3.5.3 UITableView 与 UICollectionView 控件点击事件的属性

对于UITableView与UICollectionView，则需要通过实现 Protocol来设置自定义属性：

1. 首先在 View Controller 类中实现 Protocol

2. 其次在类中设置代理，建议在viewDidLoad方法中进行设置

self.table1.gravityEngineDelegate = self;

• table1可替换为需要设置自定义属性的 View

3. 之后根据 View Controller 的类型实现方法

• 此为 UITableView 需要实现的方法

//设置UITableView的自定义属性
-(NSDictionary *) gravityEngine_tableView:(UITableView *)tableView autoTrackPropertiesAtIndexPath:(NSIndexPath *)indexPath
{
    return @{@"testProperty":@"test"};
}

• 此为 UICollectionView 需要实现的方法

//设置UICollectionView的自定义属性
-(NSDictionary *) gravityEngine_collectionView:(UICollectionView *)collectionView autoTrackPropertiesAtIndexPath:(NSIndexPath *)indexPath;
{
    return @{@"testProperty":@"test"};
}

4. 最后，在类中viewWillDisappear方法中将gravityEngineDelegate设置为nil

-(void)viewWillDisappear:(BOOL)animated
{
    [super viewWillDisappear:animated];
    self.table1.gravityEngineDelegate = nil;
}

• table1可替换为需要设置自定义属性的 View，与设置代理时对应

# 3.6 崩溃事件

当 APP 出现未捕获异常时，会上报 APP 崩溃事件

• 事件英文名：$AppCrash
• 预置属性：$app_crashed_reason，字符型，记录崩溃时的堆栈轨迹

# 4. 忽略自动采集事件

您可以通过以下方式，忽略某页面或控件的自动采集事件

# 4.1 忽略某个页面的自动采集事件

对于某些页面（View Controller），如果不想传输自动采集事件（包括页面浏览与控件点击事件），可以通过以下方法进行忽略：

NSMutableArray *array = [[NSMutableArray alloc] init];
[array addObject:@"IgnoredViewController"];

[[GravityEngineSDK sharedInstance] ignoreAutoTrackViewControllers:array];

# 4.2 忽略某个类型控件的点击事件

如果需要忽略某个类型控件的点击事件，可以使用以下方法进行忽略

[[GravityEngineSDK sharedInstance] ignoreViewType:[IgnoredClass class]];

• ignoredClass即为需要忽略的控件类型

# 4.3 忽略某个元素（View）的点击事件

如果希望忽略某个元素（View）的点击事件，可以使用以下方法进行忽略

self.table1.gravityEngineIgnoreView = YES;

• table1可替换为需要忽略的 View

# 5. 设置自定义属性

您可以调用enableAutoTrack:properties，打开自动采集功能，同时设置自定义属性

// 自动化采集自定义属性
[[GravityEngineSDK sharedInstance] enableAutoTrack:GravityEngineEventTypeAll properties:@{@"auto_key1": @"auto_value1"}];

您也可以调用setAutoTrackProperties:properties:，设置或者更新自定义属性

[[GravityEngineSDK sharedInstance] setAutoTrackProperties:GravityEngineEventTypeAppEnd properties: @{@"auto_key2": @"auto_value2";

# 6. 自动采集事件回调

您可以调用 enableAutoTrack:callback:，打开自动采集功能，您可以在 callback 中对属性进行添加和更新。

[[GravityEngineSDK sharedInstance] enableAutoTrack:GravityEngineEventTypeAll callback:^NSDictionary * _Nonnull(GravityEngineAutoTrackEventType eventType, NSDictionary * _Nonnull properties) {
    if (eventType == GravityEngineEventTypeAppStart) {
      return @{@"addkey":@"addvalue"};
    }
    if (eventType == GravityEngineEventTypeAppEnd) {
      return @{@"updatekey":@"updatevalue"};
    }
    return @{};
}];