基础 API 介绍（iOS）

[[SensorsAnalyticsSDK sharedInstance] set:@"Adsource" to:@"userSource"];

// 设定用户 AdSource 渠道为为 "App Store"
[[SensorsAnalyticsSDK sharedInstance] setOnce:@"AdSource" to:@"App Store"];

// 再次设定用户 AdSource 渠道，设定无效，AdSource 属性值仍然是 "App Store"
[[SensorsAnalyticsSDK sharedInstance] setOnce:@"AdSource" to:@"Email"];

// 将用户游戏次数属性增加一次
// increment:by: 对一个属性进行累加
[[SensorsAnalyticsSDK sharedInstance] increment:@"GamePlayed" by:[NSNumber numberWithInt:1]];

// 增加用户付费次数和积分
// increment: 对一个或多个属性进行累加
[[SensorsAnalyticsSDK sharedInstance] increment:@{@"UserPaid" : [NSNumber numberWithInt:1],
												  @"PointEarned" : [NSNumber numberWithFloat:12.5]}];

// 设定用户观影列表属性，设定后属性 "Movies" 为: [@"Sicario", @"Love Letter"]
[[SensorsAnalyticsSDK sharedInstance] append:@"Movies" by:[NSSet setWithArray:@[@"Sicario", @"Love Letter"]]];

// 取消设置 gender 属性
[[SensorsAnalyticsSDK sharedInstance] unset:@"Gender"];

UInt64 productId = 123456;
NSString *productCatalog = @"Laptop Computer";
BOOL isAddedToFavorites = NO;

[[SensorsAnalyticsSDK sharedInstance] track:@"BuyProduct"
							 withProperties:@{@"ProductID" : [NSNumber numberWithUnsignedLong:productId],
											  @"ProductCatalog" : productCatalog,
											  @"IsAddedToFav" : @(isAddedToFavorites)}];

// 开始播放视频时
[[SensorsAnalyticsSDK sharedInstance] trackTimerStart:@"WatchVideo"];

// 暂停播放时
[[SensorsAnalyticsSDK sharedInstance] trackTimerPause:@"WatchVideo"];

// 恢复播放时
[[SensorsAnalyticsSDK sharedInstance] trackTimerResume:@"WatchVideo"];

// 停止或者结束播放时
[[SensorsAnalyticsSDK sharedInstance] trackTimerEnd:@"WatchVideo" withProperties:@{@"VideoType": @"film"}];

// 开始第一个事件计时
NSString *timer1 = [[SensorsAnalyticsSDK sharedInstance] trackTimerStart:@"testTimer"];
 
// 开始第二个事件计时
NSString *timer2 = [[SensorsAnalyticsSDK sharedInstance] trackTimerStart:@"testTimer"];
 
//如果需要暂停第一个事件计时
[[SensorsAnalyticsSDK sharedInstance] trackTimerPause:timer1];
 
//如果需要恢复第一个事件计时
[[SensorsAnalyticsSDK sharedInstance] trackTimerResume:timer1];
 
// 结束第一个事件计时
[[SensorsAnalyticsSDK sharedInstance] trackTimerEnd:timer1];
 
// 结束第二个事件计时
[[SensorsAnalyticsSDK sharedInstance] trackTimerEnd:timer2];

// 开启页面离开事件采集
options.enableTrackPageLeave = YES;

// 设置物品类型为 food 且物品 ID 为 2 的物品设置物品属性 @"name": @"玉米", @"flavour": @"甜"
[[SensorsAnalyticsSDK sharedInstance] itemSetWithType:@"food" itemId:@"2" properties:@{@"name": @"玉米", @"flavour": @"甜"}];

// 删除物品类型为 food 且物品 ID 为 2 的物品
[[SensorsAnalyticsSDK sharedInstance] itemDeleteWithType:@"food" itemId:@"2"];

// 获取事件预置属性
[[SensorsAnalyticsSDK sharedInstance] getPresetProperties];

// 将 AppName 注册为公共属性
[[SensorsAnalyticsSDK sharedInstance] registerSuperProperties:@{@"AppName" : @"<#YOUR APP NAME#>"}];

[[SensorsAnalyticsSDK sharedInstance] registerDynamicSuperProperties:^NSDictionary * _Nonnull{
	return @{@"level": <#当前游戏等级#>,
			 @"balance": <#最新金币余额#>};
}];

SAConfigOptions *options = [[SAConfigOptions alloc] initWithServerURL:@"<#数据接收地址#>" launchOptions:launchOptions];

// 设置触发间隔，默认 15 * 1000 毫秒
options.flushInterval = 10 * 1000;

// 设置触发条数，默认 100 条
options.flushBulkSize = 50;

[SensorsAnalyticsSDK startWithConfigOptions:options];

// 设置上报网络策略，默认 3G、4G、5G、WiFi，注意需要初始化 SDK 之后设置
[[SensorsAnalyticsSDK sharedInstance] setFlushNetworkPolicy:SensorsAnalyticsNetworkTypeALL];

// 立即上报
[[SensorsAnalyticsSDK sharedInstance] flush];

// 设置最大缓存量，默认 10000 条
options.maxCacheSize = 20000;

[[SensorsAnalyticsSDK sharedInstance] deleteAll];

/*
设置证书校验方式，默认为 SASSLPinningModeNone
*/
SASecurityPolicy *securityPolicy = [SASecurityPolicy policyWithPinningMode:SASSLPinningModePublicKey];

/*
是否允许无效证书（自建证书），默认为 NO ，
如果是需要验证自建证书，需要设置为 YES 。
*/
securityPolicy.allowInvalidCertificates = YES;

/*
是否需要验证域名，默认为 YES ，
如证书的域名与请求的域名不一致，需把该项设置为 NO 。
*/
securityPolicy.validatesDomainName = NO;

/*
配置本地证书路径
*/
securityPolicy.pinnedCertificates = [SASecurityPolicy certificatesInBundle:[NSBundle mainBundle]];

// SDK 初始化配置
SAConfigOptions *options = [[SAConfigOptions alloc] initWithServerURL:<#数据接收地址#> launchOptions:launchOptions];
...
/*
设置证书策略
*/
options.securityPolicy = securityPolicy;
// 初始化 SDK
[SensorsAnalyticsSDK startWithConfigOptions:options];

// 开启 SDK 加密功能
options.enableEncrypt = YES;

SAConfigOptions *options = [[SAConfigOptions alloc] initWithServerURL:<#数据接收地址#> launchOptions:launchOptions]; 
//注册加密插件
SAAESStorePlugin *plugin = [[SAAESStorePlugin alloc] init];
[options registerStorePlugin:plugin]; 
[SensorsAnalyticsSDK startWithConfigOptions:options];

// 可根据需求进行组合
options.autoTrackEventType = SensorsAnalyticsEventTypeAppStart |
							 SensorsAnalyticsEventTypeAppEnd |
							 SensorsAnalyticsEventTypeAppClick |
							 SensorsAnalyticsEventTypeAppViewScreen;

// 开启自动采集子页面的浏览事件
options.enableAutoTrackChildViewScreen = YES;

// 该方法支持多次调用，对合集进行忽略
[[SensorsAnalyticsSDK sharedInstance] ignoreAutoTrackViewControllers:@[@"MyViewController",
																	   @"BaseViewController"]];

//SDK 自 4.5.10 版本提供了如下接口来忽略某个页面的浏览事件
[[SensorsAnalyticsSDK sharedInstance] ignoreAppViewScreenOnViewControllers:@[MyViewController.class]];

//SDK 自 4.5.10 版本提供了如下接口来忽略某些页面点击事件
[[SensorsAnalyticsSDK sharedInstance] ignoreAppClickOnViewControllers:@[MyViewController.class]];

// 该方法支持多次调用，对合集进行忽略
[[SensorsAnalyticsSDK sharedInstance] ignoreAutoTrackViewControllers:@[@"MyViewController",
																	   @"BaseViewController"]];

//SDK 自 4.5.10 版本提供了如下接口来忽略某些页面的点击和浏览事件
[[SensorsAnalyticsSDK sharedInstance] ignoreAppClickAndViewScreenOnViewControllers:@[MyViewController.class]];

button.sensorsAnalyticsIgnoreView = YES;

// 该方法支持多次调用，对合集进行忽略
[[SensorsAnalyticsSDK sharedInstance] ignoreViewType:[MyButton class]];
[[SensorsAnalyticsSDK sharedInstance] ignoreViewType:[MyView class]];

//SDK 自 4.5.10 版本提供了如下接口来忽略某类控件的点击事件
[[SensorsAnalyticsSDK sharedInstance] ignoreAppClickOnViews:@[MyView.class]];

// 可在 viewDidAppear: 中调用代码进行触发
[[SensorsAnalyticsSDK sharedInstance] trackViewScreen:self.childViewControllers[0]];

[[SensorsAnalyticsSDK sharedInstance] trackViewAppClick:button];

// 1. UIViewController 遵循 SAAutoTracker 协议
// 2.- getTrackProperties 协议方法中返回自定义的页面信息
- (NSDictionary *)getTrackProperties {
	return @{@"$title": @"首页",
			 @"test": @"这是一个示例"};
}

// 1. UIViewController 遵循 SAScreenAutoTracker 协议
// 2.- getScreenUrl 协议方法中返回自定义的页面标识
- (NSString *)getScreenUrl {
	return @"sa://page/product_detail";
}

homeBtn.sensorsAnalyticsViewProperties = @{@"$element_content": @"首页"};

//遵循 SAUIViewAutoTrackDelegate 协议
// 1. 给 tableView 或 collection 设置 sensorsAnalyticsDelegate
self.tableView.sensorsAnalyticsDelegate = self;

// 2. sensorsAnalyticsDelegate 中实现相应方法并返回自定义属性
-(NSDictionary *) sensorsAnalytics_tableView:(UITableView *)tableView autoTrackPropertiesAtIndexPath:(NSIndexPath *)indexPath {
	return @{@"customProperty":@"MyValue"};
}

[[SensorsAnalyticsSDK sharedInstance] enableTrackScreenOrientation:YES]; 

// CoreLocation 采集 GPS 信息
[[SensorsAnalyticsSDK sharedInstance] enableTrackGPSLocation:YES];

// 开启推送点击事件采集
options.enableTrackPush = YES;

// 开启点击分析功能
options.enableHeatMap = YES;

[[SensorsAnalyticsSDK sharedInstance] addHeatMapViewControllers:@"HomeViewController", "DiscoverViewController"];

// 开启可视化全埋点
options.enableVisualizedAutoTrack = YES;

// 只开启 MainController 的可视化全埋点
[[SensorsAnalyticsSDK sharedInstance] addVisualizedAutoTrackViewControllers:[NSArray arrayWithObject:@"MainController"]];

SAConfigOptions *options = [[SAConfigOptions alloc] initWithServerURL:SA_SERVER_URL launchOptions:launchOptions];
options.enableTrackAppCrash = YES;
[SensorsAnalyticsSDK startWithConfigOptions:options];