platform :ios, '8.0'
use_frameworks!
​
target 'YourApp' do
    pod 'AnalysysAgent'
end

+ (AnalysysAgent *)startWithConfig:(AnalysysAgentConfig *)config;

//  导入SDK
#import <AnalysysAgent/AnalysysAgent.h>
​
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    //  设置key，77a52s552c892bn442v721为样例数据，请根据实际情况替换相应内容
    //  AnalysysAgent 配置信息
    AnalysysConfig.appKey = @"77a52s552c892bn442v721";
    // 设置渠道
    AnalysysConfig.channel = @"App Store";
    // 设置追踪新用户的首次属性
    AnalysysConfig.autoProfile = YES;
    // 设置上传数据使用AES加密，需添加加密模块
    //  AnalysysConfig.encryptType = AnalysysEncryptAES;
    //  设置渠道追踪
    //  AnalysysConfig.autoInstallation = YES;
    //  是否上报设备标识
    //  AnalysysConfig.autoTrackDeviceId = YES;
    //  设置服务器时间校验
    //  AnalysysConfig.allowTimeCheck = YES;
    //  设置时间最大允许偏差为5分钟
    //  AnalysysConfig.maxDiffTimeInterval = 5 * 60;
    //  使用配置初始化SDK
    [AnalysysAgent startWithConfig:AnalysysConfig];
    
    //  4.4.5之后需要将以下设置放置到初始化后，否则可能无法正常上报
    #ifdef DEBUG
        [AnalysysAgent setDebugMode:AnalysysDebugButTrack];
    #else
        [AnalysysAgent setDebugMode:AnalysysDebugOff];
    #endif
​
    //  设置上传地址
    [AnalysysAgent setUploadURL:@"https://url:port"];
​
    return YES;
}
​

import AnalysysAgent
​
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    //  AnalysysAgent 配置信息
        AnalysysAgentConfig.shareInstance()?.appKey = "77a52s552c892bn442v721"
        AnalysysAgentConfig.shareInstance()?.channel = "App Store"
        //AnalysysAgentConfig.shareInstance()?.autoProfile = true
        //AnalysysAgentConfig.shareInstance()?.autoInstallation = true
        //AnalysysAgentConfig.shareInstance()?.autoTrackDeviceId = true
        //AnalysysAgentConfig.shareInstance()?.allowTimeCheck = true
        //AnalysysAgentConfig.shareInstance()?.maxDiffTimeInterval = 5 * 60
        //  使用配置信息初始化SDK
        AnalysysAgent.start(with: AnalysysAgentConfig.shareInstance())
        
        //  4.4.5之后需要将以下设置放置到初始化后，否则可能无法正常上报
        #if DEBUG
        AnalysysAgent.setDebugMode(.butTrack)
        #else
        AnalysysAgent.setDebugMode(.off)
        #endif
        
        AnalysysAgent.setUploadURL("https://url:port")
​
}

+ (void)setUploadURL:(NSString *)uploadURL;

//  设置自定义上传地址为`scheme://host + :port`
[AnalysysAgent setUploadURL:@"/*设置为实际地址*/"];

AnalysysAgent.setUploadURL("/*设置为实际地址*/")

+ (void)setDebugMode:(AnalysysDebugMode)debugMode;

[AnalysysAgent setDebugMode:AnalysysDebugOff];

AnalysysAgent.setDebugMode(.off)

+ (void)monitorAppDelegate:(id<UIApplicationDelegate>)delegate launchOptions:(NSDictionary *)launchOptions;

#import <AnalysysAgent/AnalysysAgent.h>
​
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
​
    /*** 请在初始化易观SDK前调用 ***/
    //  启动方式监测
    [AnalysysAgent monitorAppDelegate:self launchOptions:launchOptions];
​
    // 易观SDK初始化代码
    // .....
​
    return YES;
}
​

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { 
​
    /*** 请在初始化易观SDK前调用 ***/
    //  启动方式监测       
    AnalysysAgent.monitorAppDelegate(self, launchOptions: launchOptions)
    // 易观SDK初始化代码
    // ....
    return true
}
​

+ (void)pageView:(NSString *)pageName;
​
+ (void)pageView:(NSString *)pageName properties:(NSDictionary *)properties;

// 正在开展某个活动，需要统计活动页面
[AnalysysAgent pageView:@"活动页"];

// 访问手机活动页面，活动页面内容为优惠出售iPhone手机，手机价格为5000元
NSDictionary *properties = @{@"commodityName": @"iPhone", @"commodityPrice": @5000};
[AnalysysAgent pageView:@"商品页" properties:properties];

let properties = ["commodityName": "iPhone", "commodityPrice": 5000] as [String : Any]
AnalysysAgent.pageView("商品页", properties: properties)

+ (void)setAutomaticCollection:(BOOL)isAuto

//  关闭页面自动采集
[AnalysysAgent setAutomaticCollection:NO];

AnalysysAgent.setAutomaticCollection(false);

+ (void)setPageViewBlackListByPages:(NSSet<NSString *> *)controllers;

//  忽略页面'NextViewController'自动采集
[AnalysysAgent setPageViewBlackListByPages:[NSSet setWithObject:@"NextViewController"]];

AnalysysAgent.setPageViewBlackListByPages(["packageName.NextViewController"]);

/**
 * @protocol
 * 页面自动采集协议
 *
 * @abstract
 * 当页面开启自动采集时，追加页面自定义参数
 *
 * @discussion
 * 继承至UIViewController的子类，若遵循该协议，可将自定义页面的属性信息增加至$pageview事件中
 */
@protocol ANSAutoPageTracker <NSObject>
​
@optional
- (NSDictionary *)registerPageProperties;
​
 /** 自定义页面标识，返回信息将覆盖$url字段 */
- (NSString *)registerPageUrl;
​
@end
​

/** 若使用SDK自动采集功能，且需要添加页面自定义参数，遵循protocol <ANSAutoPageTracker>*/
@interface PageDetailViewController ()<ANSAutoPageTracker>
​
@end
​
@implementation PageDetailViewController
​
/**
 实现ANSAutoPageTracker协议
​
 @return 页面自定义参数信息
 */
- (NSDictionary *)registerPageProperties {
    //  $title为自动采集使用key，用户可覆盖
    //  增加商品标识(productID)
    return @{@"$title": @"详情页"};
}
​
/**
 页面$url字段，将覆盖SDK默认字段
​
 @return 页面标识
 */
- (NSString *)registerPageUrl {
    return @"HomePage";
}
​
@end

class PageDetailViewController: UIViewController, ANSAutoPageTracker {
    
    func registerPageProperties() -> [AnyHashable : Any]! {
        return ["$title": "详情页", "$url": "/homepage/detailpage", "productID": "1001"]
    }
    
    func registerPageUrl() -> String! {
        return "DetailPage"
    }
}

+ (void)track:(NSString *)event;
​
+ (void)track:(NSString *)event properties:(NSDictionary *)properties;

//  收藏事件
[AnalysysAgent track:@"collect"];
​
....
​
// 用户购买手机
NSMutableDictionary *properties = [NSMutableDictionary dictionary];
properties[@"type"] = @"Phone";
properties[@"name"] = @"iPhone XS Max";
properties[@"money"] = [NSNumber numberWithFloat:9599.0];
properties[@"count"] = @1;
[AnalysysAgent track:@"pay" properties:properties];

let properties = ["type": "Phone",
                  "name": "iPhone XS Max",
                 "money": 9599.0,
                 "count": 1] as [String: Any]
AnalysysAgent.track("pay", properties: properties)

+ (void)alias:(NSString *)aliasId;

//  登陆账号时调用，只设置当前登陆账号即可和之前行为打通
[AnalysysAgent alias:@"sanbo"];

AnalysysAgent.alias("zhangsan")

+ (void)identify:(NSString *)distinctId;

// 设置匿名ID为`fangke009901`，注意此方法需要在初始化之前调用
[AnalysysAgent identify:@"fangke009901"];

AnalysysAgent.identify("fangke009901")

+ (NSString *)getDistinctId;

NSString *distinctID = [AnalysysAgent getDistinctId];

let distinctID = AnalysysAgent.getDistinctId() as String

+ (void)profileSet:(NSDictionary *)property;
​
+ (void)profileSet:(NSString *)propertyName value:(id)propertyValue;

// 设置用户的 `Job` 是 `Engineer`
[AnalysysAgent profileSet:@"Job" propertyValue:@"Engineer"];
​
...
​
// 统计用户昵称和爱好信息
NSDictionary *properties = @{@"nickName":@"小叮当",@"hobby":@[@"Singing", @"Dancing"]};
[AnalysysAgent profileSet:properties];

AnalysysAgent.profileSet(["nickName": "小叮当", "hobby": ["Singing", "Dancing"]])

//  多个属性
+ (void)profileSetOnce:(NSDictionary *)property;
​
//  单个属性
+ (void)profileSetOnce:(NSString *)propertyName propertyValue:(id)propertyValue;

//  单个属性设置
[AnalysysAgent profileSetOnce:@"Birthday" propertyValue:@"1995-01-01"];

// 统计应用激活时间
[AnalysysAgent profileSetOnce:@{@"activationTime": @"1521594686781"}];

AnalysysAgent.profileSetOnce("Birthday", propertyValue: "1995-01-01")
​
AnalysysAgent.profileSetOnce(["activationTime": "1521594686781"])

//  多个属性
+ (void)profileIncrement:(NSDictionary *)property;
​
//  单个属性
+ (void)profileIncrement:(NSString *)propertyName propertyValue:(NSNumber *)propertyValue;

//  增加用户消费金额
[AnalysysAgent profileIncrement:@"Consume" propertyValue:@10];

//  增加用户登录次数加1次，积分增加10分
NSDictionary *dic = @{@"UseCount": [NSNumber numberWithInt:1],@"point": [NSNumber numberWithInt:10]};
[AnalysysAgent profileIncrement:dic];

AnalysysAgent.profileIncrement("Consume", propertyValue: 10)
​
AnalysysAgent.profileIncrement(["UseCount": 1])

//  增加单个属性
+ (void)profileAppend:(NSString *)propertyName value:(id)propertyValue;
​
//  增加多个属性
+ (void)profileAppend:(NSDictionary *)property;
​
//  增加多个属性
+ (void)profileAppend:(NSString *)propertyName propertyValue:(NSSet *)propertyValue;

//  增加用户购买书籍，属性 `Books` 为: `["西游记", "三国演义"]`，属性 `Drinks` 为：`orange juice`
[AnalysysAgent profileAppend:@{@"Books": @[@"西游记", @"三国演义"],@"Drinks": @"orange juice"}];

//  再次设定该属性，属性 `Books` 为: `["西游记", "三国演义", "红楼梦", "水浒传"]`
[AnalysysAgent profileAppend:@"Books" propertyValue:[NSSet setWithObjects:@"红楼梦", @"水浒传", nil]];

AnalysysAgent.profileAppend("Books", propertyValue: ["红楼梦", "水浒传"])

//  删除当前用户单个属性值
+ (void)profileUnset:(NSString *)propertyName;
​
//  删除当前用户所有属性值
+ (void)profileDelete;

//  删除当前用户已设置的`hobby`用户属性值
[AnalysysAgent profileUnset:@"hobby"];

//  删除当前用户已设置的所有用户属性
[AnalysysAgent profileDelete];

AnalysysAgent.profileUnset("hobby")
​
AnalysysAgent.profileDelete()

//  注册多个通用属性
+ (void)registerSuperProperties:(NSDictionary *)superProperties;
​
//  注册单个通用属性
+ (void)registerSuperProperty:(NSString *)superPropertyName value:(id)superPropertyValue;

// 在某视频平台，购买一年会员，该年内只需设置一次即可
[AnalysysAgent registerSuperProperties:@{@"member": @"VIP"}];

//  记录用户购买商品事件
[AnalysysAgent track:@"buy" properties:@{@"product":@"iPhone"}];

//  记录用户登录事件
[AnalysysAgent track:@"buy" properties:@{@"product":@"iPhone",@"member": @"VIP"}];

AnalysysAgent.registerSuperProperties(["member": "VIP"])

//  删除单个通用属性
+ (void)unregisterSuperProperty:(NSString *)superPropertyName;
​
//  清除所有通用属性
+ (void)clearSuperProperties;

//  删除已经设置的用户 `Birthday` 属性
[AnalysysAgent unregisterSuperProperty:@"Birthday"];

//  清除所有已经设置的通用属性
[AnalysysAgent clearSuperProperties];

AnalysysAgent.unregisterSuperProperty("Birthday")
​
AnalysysAgent.clearSuperProperties()

//  获取单个通用属性
+ (id)getSuperProperty:(NSString *)superPropertyName
​
//  获取所有的通用属性
+ (NSDictionary *)getSuperProperties;

// 查看已经设置的 `Hobby` 的通用属性
[AnalysysAgent getSuperProperty:@"Hobby"];

// 获取所有通用属性
[AnalysysAgent getSuperProperties]

AnalysysAgent.getSuperProperty("Hobby")
​
AnalysysAgent.getSuperProperties()

+ (void)setIntervalTime:(NSInteger)flushInterval;

[AnalysysAgent setIntervalTime:10];

AnalysysAgent.setIntervalTime(10)

+ (void)setMaxEventSize:(NSInteger)size;

// 修改为每缓存 20 条数据，触发一次上传
[AnalysysAgent setMaxEventSize:20];

AnalysysAgent.setMaxEventSize(20)

+ (void)setMaxCacheSize:(NSInteger)size;

[AnalysysAgent setMaxCacheSize:2000];

AnalysysAgent.setMaxCacheSize(2000)

+ (void)flush;

[AnalysysAgent flush];

AnalysysAgent.flush()

+ (void)cleanDBCache;

[AnalysysAgent cleanDBCache];

AnalysysAgent.cleanDBCache()    

/**
 允许数据上传的网络类型
 
 - AnalysysNetworkNONE: 不允许上传
 - AnalysysNetworkWWAN: 移动网络
 - AnalysysNetworkWIFI: WIFI网络
 - AnalysysNetworkALL: 有网络即可
 */
typedef NS_ENUM(NSInteger, AnalysysNetworkType) {
    AnalysysNetworkNONE = 1<<0,
    AnalysysNetworkWWAN = 1<<1,
    AnalysysNetworkWIFI = 1<<2,
    AnalysysNetworkALL = 0xFF
};
​
+ (void)setUploadNetworkType:(AnalysysNetworkType)networkType;

[AnalysysAgent setUploadNetworkType:AnalysysNetworkWIFI];

AnalysysAgent.setUploadNetworkType(.WIFI)

+ (NSDictionary *)getPresetProperties;

NSDictionary *preProperties = [AnalysysAgent getPresetProperties];

let presetProperties = AnalysysAgent.getPresetProperties()

+ (void)reset;