iOS SDK 使用说明

该 SDK 适用于 iOS 原生 App。

1. 集成准备

1.1 下载 SDK

更新时间：2018/12/27

更新内容：

优化及修复部分bug；

1.2 集成 SDK

1.2.1 基本工程配置

选择工程 - 右键 - 将文件添加到 "ProjectName"
选择 AnalysysAgent.framework 文件
勾选 如有需要复制项目、创建组 - 添加 完成添加库

添加依赖框架。选择工程 - Targets - “项目名称” - Build Phase - Link Binary With Libraries 依赖库如下：

类库	用途
`AnalysysAgent.framework`	易观类库
`AdSupport.framework`	获取广告标识
`CoreTelephony.framework`	获取运营商标识
`SystemConfiguration.framework`	获取当前网络状态
`libz.tbd`	数据压缩（Xcode7以下:libz.dylib）
`libicucore.tbd`	网络连接

Targets - “项目名称” - Build Settings - Other Linker Flags ，添加 -ObjC 选项（注意大小写）

1.2.2 Swift 集成配置

若使用 Swift 语言工程开发集成，则除 1.2.1 配置外还需要添加桥接文件，该文件可以使用以下两种方式之一创建：

在工程中添加 XXX-Bridging-Header.h 文件（ XXX 为工程名称），并在 Build Setting - Objective-C Bridging Header 中添加桥接文件路径。
在工程中创建 Objective-C 文件，系统会提示是否创建桥接文件，选择创建即可生成桥接文件

创建完成之后，在 XXX-Bridging-Header.h 文件并引入类库： #import <AnalysysAgent/AnalysysAgent.h>

2. SDK 初始化

2.1 初始化接口

Objective-C 代码示例

在Xcode工程文件~AppDelegate.m 中导入头文件"#import <AnalysysAgent/AnalysysAgent.h>"。接口如下：

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

AnalysysAgentConfig 类为配置信息类。参数如下：

appKey：网站获取，唯一标识

channel：应用下发渠道

baseURL：设置 URL 地址(只支持域名，如：growth.analysys.cn，则默认使用的上行数据地址https://growth.analysys.cn，websocket 地址使用的是wss://growth.analysys.cn。如果需要上传数据使用http协议或者 websocket 使用的是 ws 协议，此处可赋值为空，调用接口 setUploadURL(4.1.1)/setVisitorDebugURL(4.1.2)/setVisitorConfigURL(4.1.2) 设置即可)

autoProfile：设置是否追踪新用户的首次属性。NO：不追踪新用户首次属性；YES：追踪新用户首次属性（默认）

encryptTyp：设置数据上传时的加密方式，目前只支持AES加密（AnalysysEncryptAES）；如不设置此参数，数据上传不加密。

示例：

//  导入SDK
#import <AnalysysAgent/AnalysysAgent.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

    //  网站申请 key ：77a52s552c892bn442v721，渠道：App Store
    //  AnalysysAgent 配置信息
    AnalysysConfig.appKey = @"77a52s552c892bn442v721";
    AnalysysConfig.channel = @"App Store";
    AnalysysConfig.baseUrl = @"growth.analysys.cn";
    //  AnalysysConfig.autoProfile = YES;  //  默认为YES
    //  AnalysysConfig.encryptType = AnalysysEncryptAES;
    //  使用配置信息初始化SDK
    [AnalysysAgent startWithConfig:AnalysysConfig];

    #ifdef DEBUG
    //  debug模式下查看日志
    [AnalysysAgent setDebugMode:AnalysysDebugOnly];
    #endif
        
    return YES;
}

Swift代码示例

在桥接文件中导入类库 #import <AnalysysAgent/AnalysysAgent.h>，并在 ~AppDelegate.m 中配置。

示例

import AnalysysAgent

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

    //  AnalysysAgent 配置信息
    AnalysysAgentConfig.shareInstance().appKey = "77a52s552c892bn442v721"
    AnalysysAgentConfig.shareInstance().channel = "App Store"
    AnalysysAgentConfig.shareInstance().baseUrl = "growth.analysys.cn"
    AnalysysAgentConfig.shareInstance().autoProfile = true
    AnalysysAgentConfig.shareInstance().encryptType = .AES
    //  使用配置信息初始化SDK
    AnalysysAgent.start(with: AnalysysAgentConfig.shareInstance())

}

注意：默认 SDK 为非调试模式，不能查看日志，若要查看日志请调用 setDebugMode: 方法设置。请在正式发布 App 时使用 AnalysysDebugOff 模式！

3. 基础接口介绍

3.1 调试模式

调试模式主要用于开发者测试，设置调试模式。接口如下

+ (void)setDebugMode:(AnalysysDebugMode)debugMode;

debugMode：调试模式，默认关闭状态。注意：发布版本时 debugMode 模式设置为 AnalysysDebugOff。
- AnalysysDebugOff：表示关闭
- AnalysysDebugOnly：表示开启调试模式，但该模式下发送的数据仅用于调试，不计入平台数据统计
- AnalysysDebugButTrack：表示开启调试模式，该模式下发送的数据可计入平台数据统计

示例：

[AnalysysAgent setDebugMode:AnalysysDebugOff];

Swift代码示例

AnalysysAgent.setDebugMode(.off)

3.2 统计页面

页面跟踪，SDK 默认设置跟踪所有页面（继承自UIViewController的控制器），支持自定义页面信息。接口如下

+ (void)pageView:(NSString *)pageName;

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

pageName：页面标识，为字符串，以字母或 $ 开头，只能包含字母、数字、下划线和 $，字母不区分大小写，$ 开头为预置事件/属性，最大长度 255字符，不支持乱码和中文
properties：页面信息，properties 最多包含 100条，且 key 以字母或 $ 开头，只能包括字母、数字、下划线和 $，字母不区分大小写，$ 开头为预置事件/属性，不支持乱码和中文；value 支持类型：NSString/NSNumber/NSArray<NSString *>/NSSet<NSString *>/NSDate/NSURL，若为字符串，最大长度 255字符

示例1：

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

示例2：

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

Swift代码示例：

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

3.2.1 自动采集页面

自动采集页面信息开关，开启时自动记录用户访问的页面。默认为开启状态。接口如下：

+ (void)setAutomaticCollection:(BOOL)isAuto

isAuto：开关值，默认为YES开启，设置NO为关闭

示例：

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

Swift代码示例

AnalysysAgent.setAutomaticCollection(false)

3.2.2 忽略部分页面自动采集

开发者可以设置某些页面不被自动采集，设置后自动采集时将会忽略这些页面。接口如下

+ (void)setIgnoredAutomaticCollectionControllers:(NSArray<NSString *> *)controllers;

controllers：需要忽略的控制器名称，字符串数组。

示例：

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

Swift代码示例

AnalysysAgent.setIgnoredAutomaticCollectionControllers(["NextViewController"]);

3.3 统计事件

用户行为追踪，可以设置自定义属性。接口如下：

+ (void)track:(NSString *)event;

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

event：事件名称，以字母或 $ 开头，只能包含字母、数字、下划线和 $，字母不区分大小写，$ 开头为预置事件/属性，最大长度 99字符，不支持乱码和中文
properties：自定义属性，用于对事件描述。eventInfo最多包含 100条，且 key 以字母或 $ 开头，只能包含字母、数字、下划线和 $，字母不区分大小写，$ 开头为预置事件/属性，最大长度 125字符，不支持乱码和中文；value 支持类型：NSString/NSNumber/NSArray<NSString *>/NSSet<NSString *>/NSDate/NSURL，若为字符串，最大长度 255字符

示例：

//  收藏事件
[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];

Swift代码示例

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

3.4 用户关联

用户ID关联接口。将aliasID和originalId关联，计算时认为是一个用户的行为。接口如下：

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

aliasId：新的唯一用户ID。长度大于0且小于255字符
originalId：待关联的用户ID，可以是现在使用也可以是历史使用的ID,不局限于本地当前使用的ID。可以为空值，若为空时使用本地的distinctId。长度大于0且小于255字符

示例：

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

......

//  现在登陆账号是zhangsan，和历史上的 lisi是一个人。 此时不会关心登陆 zhangsan前的用户是谁
[AnalysysAgent alias:@"zhangsan" originalId:@"lisi"];

Swift代码示例：

AnalysysAgent.alias("zhangsan", originalId: "lisi")

3.5 用户属性设置

用户属性是一个标准的K-V结构，K和V都有相应的约束条件，如不符合则丢弃该次操作。

约束条件如下：

属性名称

以字母或$开头，只能包含字母、数字、下划线和$，字母不区分大小写，$开头为预置事件/属性，最大长度125字符，不支持乱码和中文
属性值

支持部分类型：NSString/NSNumber/NSArray<NSString *>/NSSet<NSString *>/NSDate/NSURL；若为字符串，则最大长度255字符；若为数组或集合，则最多包含100条，且key约束条件与属性名称一致，value最大长度255字符

给用户设置单个或多个属性，如果之前不存在，则新建，否则覆盖。接口如下：

+ (void)profileSet:(NSDictionary *)property;

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

propertyName：属性名称，约束见属性名称
propertyValue：属性值，约束见属性值
property：属性列表，约束见属性名称，属性值

示例1：

// 设置用户的 `Job` 是 `Engineer`
[AnalysysAgent profileSet:@"Job" propertyValue:@"Engineer"];

...

// 统计用户昵称和爱好信息
NSDictionary *properties = @{@"nickName":@"小叮当",@"hobby":@[@"Singing", @"Dancing"]};
[AnalysysAgent profileSet:properties];

Swift代码示例：

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

4. 更多接口

4.1 单独指定上报地址设置

该方法仅在方舟私有化部署版本中有效，你可以将服务器地址设置为安装方舟服务器的实际地址。这里指定的服务器必须对公网可见。

4.1.1 设置数据上报地址

自定义上传地址，设置接口后，所有事件信息将上传到此地址。接口如下：

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

uploadURL：数据上传地址，格式为 scheme://host + :port(不包括 / 后的内容)。其中，scheme 必须以 http:// 或 https:// 开头，host 只支持域名和 IP，长度小于 255 字符，port 端口号必须携带。

示例：

//  设置自定义上传地址为`http://growth.analysys.cn:8089`
[AnalysysAgent setUploadURL:@"http://growth.analysys.cn:8089"];

Swift示例

AnalysysAgent.setUploadURL("http://growth.analysys.cn:8089")

4.1.2 设置可视化埋点上报地址

设置可视化调试阶段连接的 Websocket 服务器地址

接口如下：

+ (void)setVisitorDebugURL:(NSString *)visitorDebugURL;

visitorDebugURL：websocket 服务器地址，格式为 scheme://host + :port(不包括 / 后的内容)。其中，scheme 必须以 ws:// 或 wss:// 开头，host 只支持域名和 IP，长度小于 255 字符，port 端口号必须携带。

示例：

//  设置websocket服务器地址为`ws://growth.analysys.cn:9091`
[AnalysysAgent setVisitorDebugURL:@"ws://growth.analysys.cn:9091"];

Swift示例

AnalysysAgent.setVisitorDebugURL("ws://growth.analysys.cn:9091")

设置可视化请求埋点配置的服务器地址

接口如下：

+ (void)setVisitorConfigURL:(NSString *)configURL;

configURL：请求埋点配置的服务器地址，格式：http://host:port 或 https://host:port

示例：

//  设置请求埋点配置的服务器地址为`http://growth.analysys.cn:8089`
[AnalysysAgent setVisitorConfigURL:@"http://growth.analysys.cn:8089"];

Swift示例

AnalysysAgent.setVisitorConfigURL("http://growth.analysys.cn:8089")

4.2 用户属性

4.2.1 用户 ID 设置

唯一身份标识设置，接口如下：

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

distinctId：唯一身份标识，长度大于 0 且小于 255 字符。

示例：

// 淘宝店铺，统计到来访用户
[AnalysysAgent identify:@"fangke009901"];

....

// 淘宝店铺，统计到老客用户
[AnalysysAgent identify:@"laoke008021"]

Swift代码示例：

AnalysysAgent.identify("fangke009901")

4.2.2 设置用户固有属性

设置用户的固有属性，只在首次设置时有效。例如：应用的激活时间、首次登录时间等。如果已被设置的用户属性存在，则此记录会被忽略不会覆盖已有数据；如果属性不存在，则会自动创建。接口如下：

//  多个属性
+ (void)profileSetOnce:(NSDictionary *)property;

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

propertyName：属性名称，约束见属性名称(4.2.2)
propertyValue：属性值，约束见属性值(4.2.2)
property：集合类型属性值，约束见属性名称(4.2.2) 以及 属性值(4.2.2)

示例1：统计用户的出生日期

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

示例2：

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

Swift代码示例：

AnalysysAgent.profileSetOnce("Birthday", propertyValue: "1995-01-01")

AnalysysAgent.profileSetOnce(["activationTime": "1521594686781"])

4.2.3 设置用户属性相对变化值

设置用户属性的相对变化值(相对增加，减少)，只能对数值型属性进行操作，如果这个 Profile 之前不存在，则初始值为 0。接口如下：

//  多个属性
+ (void)profileIncrement:(NSDictionary *)property;

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

propertyName：属性名称，约束见属性名称(4.2.2)
propertyValue：属性值，约束见属性值(4.2.2)
property：集合类型属性值，约束见属性名称(4.2.2) 以及 属性值(4.2.2)

示例1：

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

示例2：

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

Swift代码示例：

AnalysysAgent.profileIncrement("Consume", propertyValue: 10)

AnalysysAgent.profileIncrement(["UseCount": 1])

4.2.4 新增列表类型的属性

用户列表属性增加元素。接口如下：

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

//  增加多个属性
+ (void)profileAppend:(NSDictionary *)property;

//  增加多个属性
+ (void)profileAppend:(NSString *)propertyName propertyValue:(NSSet *)propertyValue;

propertyName：属性名称，约束见属性名称(4.2.2)
propertyValue：属性值，约束见属性值(4.2.2)
property：集合类型属性值，约束见属性名称(4.2.2) 以及 属性值(4.2.2)

示例1：

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

示例2：

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

Swift代码示例：

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

4.2.5 删除设置的属性

删除已设置的用户属性。接口如下：

//  删除单个用户属性
+ (void)profileUnset:(NSString *)propertyName;

//  删除所有用户属性
+ (void)profileDelete;

propertyName：属性名称，约束见属性名称(4.2.2)

示例1：

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

示例2：

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

Swift代码示例：

AnalysysAgent.profileUnset("hobby")

AnalysysAgent.profileDelete()

4.3 通用属性

通用属性是每次上传事件信息都会带有的属性，通用属性是一个标准的 K-V 结构，K 和 V 均有相应的约束条件，如不符合则丢弃该次操作。

约束条件如下

属性名称

以字母或$开头，只能包含字母、数字、下划线和$，字母不区分大小写，$开头为预置事件/属性，最大长度125字符，不支持乱码和中文
属性值

支持部分类型：NSString/NSNumber/NSArray<NSString *>/NSSet<NSString *>/NSDate/NSURL；若为字符串，则最大长度 255字符；若为数组或集合,则最多包含 100条，且 key 约束条件与属性名称一致，value 最大长度 255字符

4.3.1 注册通用属性

某一个体，在固定范围内，持续拥有的属性，每次数据上传都会携带。接口如下

//  注册多个通用属性
+ (void)registerSuperProperties:(NSDictionary *)superProperties;

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

superPropertyName：属性名称，约束见属性名称(4.2.2)
superPropertyValue：属性值，约束见属性值(4.2.2)
superProperties：集合类型属性值，满足属性名称(4.2.2) 和属性值(4.2.2)约束

示例：

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

成功设置事件通用属性后，事件通用属性会被添加进每个事件中，例如：

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

在设置事件通用属性后，实际发送的事件中会被加入 'member' 属性，等价于如下代码：

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

Swift代码示例：

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

重复调用 registerSuperProperties: 会覆盖之前已设置的通用属性，通用属性会保存在 App 本地缓存中。

当 superProperties 通用属性和用户自定义属性的 Key 冲突时，用户自定义属性会覆盖 superProperties 通用属性。

4.3.2 删除通用属性

根据属性名称，删除已设置过的通用属性。接口如下：

//  删除单个通用属性
+ (void)unregisterSuperProperty:(NSString *)superPropertyName;

//  清除所有通用属性
+ (void)clearSuperProperties;

superPropertyName ：属性名称，约束见属性名称(4.2.2)

示例1：

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

示例2：

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

Swift代码示例：

AnalysysAgent.unregisterSuperProperty("Birthday")

AnalysysAgent.clearSuperProperties()

4.3.3 获取通用属性

查询获取通用属性。接口如下：

//  获取单个通用属性
+ (id)getSuperProperty:(NSString *)superPropertyName

//  获取所有的通用属性
+ (NSDictionary *)getSuperProperties;

superPropertyName：属性名称，约束见属性名称(4.2.2)

示例1：

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

示例2：查看所有已经设置的通用属性

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

Swift代码示例：

AnalysysAgent.getSuperProperty("Hobby")

AnalysysAgent.getSuperProperties()

4.4 SDK 发送策略

4.4.1 设置上传间隔时间

上传间隔时间设置，在 debug 模式关闭后生效。当事件触发间隔时间大于等于设置时间，则上传数据；默认 SDK 上传时间隔为 15s，设置后以设置为准，接口如下：

+ (void)setIntervalTime:(NSInteger)flushInterval;

flushInterval：间隔时间，时间单位为秒，且最小间隔为1秒

示例：如设置上传间隔时间为10秒

[AnalysysAgent setIntervalTime:10];

Swift代码示例

AnalysysAgent.setIntervalTime(10)

4.4.2 设置事件最大上传条数

上传条数设置，在 debug 模式关闭后生效；当数据库内事件条数大于设置条数则上传数据，默认上传的条数为 10条。接口如下：

+ (void)setMaxEventSize:(NSInteger)size;

size：上传条数，size 必须值大于等于 1

示例：设置上传条数为 20条

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

Swift代码示例

AnalysysAgent.setMaxEventSize(20)

4.4.3 本地缓存上限值

SDK 本地默认缓存数据的上限值为 10000条，当达到此阈值值将会删除最早 10条数据。可以通过 setMaxCacheSize 方法来设定缓存数据的上限值（参数单位/条）。接口如下：

+ (void)setMaxCacheSize:(NSInteger)size;

size：本地最多数据缓存条数

示例：设置本地数据缓存上限值为 2000条

[AnalysysAgent setMaxCacheSize:2000];

Swift代码示例

AnalysysAgent.setMaxCacheSize(2000)

4.4.4 手动上传

调用该接口立刻上传数据，接口如下：

+ (void)flush;

示例：如需主动刷新本地数据，可直接调用

[AnalysysAgent flush];

Swift代码示例

AnalysysAgent.flush()

4.5 清除本地设置

清除本地现有的设置（包括id和通用属性）重新开始统计。接口如下：

+ (void)reset;

示例：清除本地现有的设置，包括id和通用属性

[AnalysysAgent reset];

Swift代码示例：

AnalysysAgent.reset()

5. 消息推送

5.1 简介

推送消息是一种常用的运营方法。在合适的时间将合适的内容通过合适的方式推送给合适的人群，不仅能促进用户活跃，也能极大提升用户对产品的体验。易观推送现在支持极光、个推、百度、小米四个第三方平台。支持通过易观开发者平台设置以下三种类型的推送消息内容：

下发通知，点击通知，打开宿主 App
下发通知，点击通知，打开宿主 App 的特定页面
下发通知，点击通知，触发打开特定的 URL 页面

首先，开发者需要在 App 中集成第三方推送系统的 SDK，并在 App 初始化过程中获取设备推送 ID，并保存到方舟分析的用户信息中。以下简要说明集成第三方推送系统的集成方式

5.2 设置设备推送 ID

该接口用于设置推送平台（provider）提供的设备推送ID。

+ (void)setPushProvider:(AnalysysPushProvider)provider pushID:(NSString *)pushID;

provider 推送提供方标识，目前只AnalysysPushProvider 枚举中的类型
pushID 第三方推送标识。如：极光的 registrationID，个推的 clientId，百度的 channelid，小米的 xmRegId

调用方法，以极光为例：

[AnalysysAgent setPushProvider:AnalysysPushJiGuang pushID:@"191e35f7e01617e5181"];

Swift示例

AnalysysAgent.setPushProvider(.jiGuang, pushID: "191e35f7e01617e5181")

5.2.1 极光推送

请下载最新的极光推送 SDK，并根据《iOS SDK 集成指南》将 SDK 集成至开发者 App 中。并集成并初始化方舟 SDK。

在 iOS App 中，首先获取 APNs 的 Device Token，然后注册极光推送，成功后极光推送会返回 registrationID，将此 registrationID 回传方舟 SDK 即可。

@interface AppDelegate () <JPUSHRegisterDelegate>

@end

#import <AnalysysAgent/AnalysysAgent.h>
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

    // 初始化极光SDK后，获取 registrationID 并回传
    [JPUSHService registrationIDCompletionHandler:^(int resCode, NSString *registrationID) {
        if(resCode == 0){
            //  回传
            [AnalysysAgent setPushProvider:AnalysysPushJiGuang pushID:registrationID];
        } else{
            NSLog(@"registrationID获取失败，code：%d",resCode);
        }
    }];
}

//  获取 APNS Token 值
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {

    //  向极光注册 deviceToken
    [JPUSHService registerDeviceToken:deviceToken];
}

5.2.2 百度推送

请下载最新的百度推送 SDK，并根据《百度Push服务SDK用户手册（iOS版）》将 SDK 集成至开发者 App 中。并集成并初始化方舟 SDK。

在 iOS App 中，首先获取 APNs 的 Device Token，然后注册百度推送，成功后百度推送会返回 channelid，将此 channelid 回传方舟 SDK 即可。

@interface AppDelegate () <UIApplicationDelegate,UNUserNotificationCenterDelegate>

@end

#import <AnalysysAgent/AnalysysAgent.h>
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

    // 初始化百度SDK后，获取 channelid 并回传
    [BPush bindChannelWithCompleteHandler:^(id result, NSError *error) {
        if (error) {
            return ;
        }
        if (result) {
            if ([result[@"error_code"]intValue]!=0) {
                return;
            }
            NSString *channelid = [BPush getChannelId];
            //  回传
            [AnalysysAgent setPushProvider:AnalysysPushBaiDu pushID:channelid];
        }
    }];
}

//  获取 APNS Token 值
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {

    //  向百度注册 deviceToken
    [BPush registerDeviceToken:deviceToken];
}

5.2.3 小米推送

请下载最新的小米推送 SDK，并根据《小米推送服务iOS客户端SDK使用指南》将 SDK 集成至开发者 App 中。并集成并初始化方舟SDK。

在 iOS App 中，首先获取 APNs 的 Device Token，然后注册小米推送，成功后小米推送会返回 regid，将此 regid 回传方舟 SDK 即可。

@interface AppDelegate () <MiPushSDKDelegate,UNUserNotificationCenterDelegate>

@end

#import <AnalysysAgent/AnalysysAgent.h>
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // 只启动APNs.
    [MiPushSDK registerMiPush:self];
}

//  获取 APNS Token 值
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {

    //  向小米注册 deviceToken
    [MiPushSDK bindDeviceToken:deviceToken];
}

#pragma mark *** MiPushSDKDelegate ***
- (void)miPushRequestSuccWithSelector:(NSString *)selector data:(NSDictionary *)data {
    if ([selector isEqualToString:@"bindDeviceToken:"]) {
        NSString *xmRegId = data[@"regid"];
        //  回传
        [AnalysysAgent setPushProvider:AnalysysPushXiaoMi pushID:xmRegId];
    }
}

5.2.4 个推推送

请下载最新的个推推送 SDK，并根据《iOS端 > Xcode集成》将 SDK 集成至开发者 App 中。并集成并初始化方舟 SDK。

在 iOS App 中，首先获取 APNs 的 Device Token，然后注册个推推送，成功后个推推送会返回 clientId，将此 clientId 回传方舟 SDK 即可。

@interface AppDelegate () <UIApplicationDelegate, GeTuiSdkDelegate, UNUserNotificationCenterDelegate>

@end

#import <AnalysysAgent/AnalysysAgent.h>
//  获取 APNS Token 值
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {

    //  向个推注册 deviceToken
    [GeTuiSdk registerDeviceToken:token];
}

#pragma mark *** GeTuiSdkDelegate ***
/** SDK启动成功返回cid */
- (void)GeTuiSdkDidRegisterClient:(NSString *)clientId {
    //  回传
    [AnalysysAgent setPushProvider:AnalysysPushGeTui pushID:clientId];
}

5.3 统计活动推广信息

追踪记录 provider 对应平台的消息推送的信息。

接口如下：

+ (void)trackCampaign:(id)userInfo isClick:(BOOL)isClick;

+ (void)trackCampaign:(id)userInfo isClick:(BOOL)isClick userCallback:(void(^)(id campaignInfo))userCallback;

userInfo：推送携带的参数信息
isClick：YES：用户点击通知；NO：接收到消息通知
userCallback：将解析后的用户下发活动信息回调用户

5.4 三方推送平台 SDK 集成及示例代码

首先，开发者需要在 App 中集成第三方推送系统的 SDK，并在 App 初始化过程中获取设备推送 ID，并保存在方舟分析的用户信息中。目前易观 SDK 支持极光、百度、小米、个推四家第三方推送统计的支持。以下简要说明集成第三方推送系统的集成方式。

5.4.1 极光推送

#pragma mark *** JPUSHRegisterDelegate ***

// >= iOS 10 Support , App Forground
- (void)jpushNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(NSInteger))completionHandler {
    NSDictionary * userInfo = notification.request.content.userInfo;

    if([notification.request.trigger isKindOfClass:[UNPushNotificationTrigger class]]) {
        //  收到推送消息，追踪"App 消息推送"事件
        [AnalysysAgent trackCampaign:userInfo isClick:NO userCallback:^(id campaignInfo) {
            NSLog(@"此处可根据需要处理数据 : %@",campaignInfo);
        }];

        [JPUSHService handleRemoteNotification:userInfo];
    }
    completionHandler(UNNotificationPresentationOptionBadge | UNNotificationPresentationOptionSound | UNNotificationPresentationOptionAlert); // 需要执行这个方法，选择是否提醒用户，有Badge、Sound、Alert三种类型可以选择设置
}

// iOS 10 Support, App Background
- (void)jpushNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)())completionHandler {
    NSDictionary *userInfo = response.notification.request.content.userInfo;

    if([response.notification.request.trigger isKindOfClass:[UNPushNotificationTrigger class]]) {
        //  点击通知栏打开消息，记录"App 点击通知"事件
        [AnalysysAgent trackCampaign:userInfo isClick:YES userCallback:^(id campaignInfo) {
            NSLog(@"此处可根据需要处理数据 : %@",campaignInfo);
        }];

        [JPUSHService handleRemoteNotification:userInfo];
    }
    completionHandler();
}

//  >= iOS 7 <iOS 10
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler {
    [JPUSHService handleRemoteNotification:userInfo];

    completionHandler(UIBackgroundFetchResultNewData);

    [self handleRemoteNotificationWithApplication:application userInfo:userInfo];
}

// < iOS 7
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo {
    [JPUSHService handleRemoteNotification:userInfo];

    [self handleRemoteNotificationWithApplication:application userInfo:userInfo];
}

5.4.2 百度推送

#pragma mark *** UNUserNotificationCenterDelegate ***
// >= iOS 10 Support , App Forground
- (void)userNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions))completionHandler {
    NSDictionary * userInfo = notification.request.content.userInfo;

    if([notification.request.trigger isKindOfClass:[UNPushNotificationTrigger class]]) {
        [BPush handleNotification:userInfo];
        //  收到推送消息，追踪"App 消息推送"事件
        [AnalysysAgent trackCampaign:userInfo isClick:NO userCallback:^(id campaignInfo) {
            NSLog(@"此处可根据需要处理数据 : %@",campaignInfo);
        }];
    }

    // 根据APP需要，判断是否要提示用户Badge、Sound、Alert
    completionHandler(UNNotificationPresentationOptionBadge | UNNotificationPresentationOptionSound | UNNotificationPresentationOptionAlert);
}

// iOS 10 Support, App Background
- (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)())completionHandler {
    NSDictionary *userInfo = response.notification.request.content.userInfo;

    if([response.notification.request.trigger isKindOfClass:[UNPushNotificationTrigger class]]) {
        //  点击通知栏打开消息，记录"App 点击通知"事件
        [AnalysysAgent trackCampaign:userInfo isClick:YES userCallback:^(id campaignInfo) {
            NSLog(@"此处可根据需要处理数据 : %@",campaignInfo);
        }];

        [BPush handleNotification:userInfo];
    }
    completionHandler();
}

//  >= iOS 7 <iOS 10
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler {
    [BPush handleNotification:userInfo];

    completionHandler(UIBackgroundFetchResultNewData);

    [self handleRemoteNotificationWithApplication:application userInfo:userInfo];
}

// < iOS 7
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo {
    [BPush handleNotification:userInfo];

    [self handleRemoteNotificationWithApplication:application userInfo:userInfo];
}

5.4.3 小米推送

#pragma mark *** UNUserNotificationCenterDelegate ***
// >= iOS 10 Support , App Forground
- (void)userNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions))completionHandler {
    NSDictionary * userInfo = notification.request.content.userInfo;

    if([notification.request.trigger isKindOfClass:[UNPushNotificationTrigger class]]) {
        [MiPushSDK handleReceiveRemoteNotification:userInfo];
        //  收到推送消息，追踪"App 消息推送"事件
        [AnalysysAgent trackCampaign:userInfo isClick:NO userCallback:^(id campaignInfo) {
            NSLog(@"此处可根据需要处理数据 : %@",campaignInfo);
        }];
    }

    // 根据APP需要，判断是否要提示用户Badge、Sound、Alert
    completionHandler(UNNotificationPresentationOptionBadge | UNNotificationPresentationOptionSound | UNNotificationPresentationOptionAlert);
}

// iOS 10 Support, App Background
- (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)())completionHandler {
    NSDictionary *userInfo = response.notification.request.content.userInfo;

    if([response.notification.request.trigger isKindOfClass:[UNPushNotificationTrigger class]]) {
        //  点击通知栏打开消息，记录"App 点击通知"事件
        [AnalysysAgent trackCampaign:userInfo isClick:YES userCallback:^(id campaignInfo) {
            NSLog(@"此处可根据需要处理数据 : %@",campaignInfo);
        }];

        [MiPushSDK handleReceiveRemoteNotification:userInfo];
    }
    completionHandler();
}

//  >= iOS 7 <iOS 10
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler {
    [MiPushSDK handleReceiveRemoteNotification:userInfo];

    completionHandler(UIBackgroundFetchResultNewData);

    [self handleRemoteNotificationWithApplication:application userInfo:userInfo];
}

// < iOS 7
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo {
    [MiPushSDK handleReceiveRemoteNotification:userInfo];

    [self handleRemoteNotificationWithApplication:application userInfo:userInfo];
}

5.4.4 个推推送

// iOS 10 Support, App Background
- (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)())completionHandler {
    NSDictionary *userInfo = response.notification.request.content.userInfo;

    if([response.notification.request.trigger isKindOfClass:[UNPushNotificationTrigger class]]) {
        //  点击通知栏打开消息，记录"App 点击通知"事件
        [AnalysysAgent trackCampaign:userInfo isClick:YES userCallback:^(id campaignInfo) {
            NSLog(@"此处可根据需要处理数据 : %@",campaignInfo);
        }];

        [GeTuiSdk handleRemoteNotification:userInfo];
    }
    completionHandler();
}

//  >= iOS 7 <iOS 10
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler {
    [GeTuiSdk handleRemoteNotification:userInfo];

    completionHandler(UIBackgroundFetchResultNewData);

    [self handleRemoteNotificationWithApplication:application userInfo:userInfo];
}

#pragma mark *** GeTuiSdkDelegate ***
/** SDK收到透传消息回调 */
- (void)GeTuiSdkDidReceivePayloadData:(NSData *)payloadData andTaskId:(NSString *)taskId andMsgId:(NSString *)msgId andOffLine:(BOOL)offLine fromGtAppId:(NSString *)appId {
    // [ GTSdk ]：汇报个推自定义事件(反馈透传消息)
    [GeTuiSdk sendFeedbackMessage:90001 andTaskId:taskId andMsgId:msgId];

    // 数据转换
    NSString *payloadMsg = nil;
    if (payloadData) {
        payloadMsg = [[NSString alloc] initWithBytes:payloadData.bytes length:payloadData.length encoding:NSUTF8StringEncoding];

        //  若App在前台时用户做弹框等处理，请适当调整isClick:参数（是否用户点击）
        [AnalysysAgent trackCampaign:payloadMsg isClick:NO userCallback:^(id campaignInfo) {
            NSLog(@"此处可根据需要处理数据 : %@",campaignInfo);
        }];
    }
}

注：iOS 10.0以下回调方法统一调用的方法：

//  <iOS 10 版本统一处理通知回调方法
- (void)handleRemoteNotificationWithApplication:(UIApplication *)application userInfo:(NSDictionary *)userInfo{
    if (application.applicationState == UIApplicationStateActive) {
        //  App前台 收到推送消息，追踪"App 消息推送"事件
        [AnalysysAgent trackCampaign:userInfo isClick:NO userCallback:^(id campaignInfo) {
            NSLog(@"此处可根据需要处理数据 : %@",campaignInfo);
        }];

    } else if (application.applicationState == UIApplicationStateBackground) {
        //  App后台 收到推送消息，追踪"App 消息推送"事件
        [AnalysysAgent trackCampaign:userInfo isClick:NO userCallback:^(id campaignInfo) {
            NSLog(@"此处可根据需要处理数据 : %@",campaignInfo);
        }];
    } else {
        //  App非活动状态
        //  点击通知栏打开消息，记录"App 点击通知"事件
        [AnalysysAgent trackCampaign:userInfo isClick:YES userCallback:^(id campaignInfo) {
            NSLog(@"此处可根据需要处理数据 : %@",campaignInfo);
        }];
    }
}

AnalysysAgentDynamic 4.1.1.2

AnalysysAgentDynamic 4.1.1.2

AnalysysAgentDynamic 4.1.1.2

iOS SDK 使用说明

1. 集成准备

1.1 下载 SDK

1.2 集成 SDK

1.2.1 基本工程配置

1.2.2 Swift 集成配置

2. SDK 初始化

2.1 初始化接口

3. 基础接口介绍

3.1 调试模式

3.2 统计页面

3.2.1 自动采集页面

3.2.2 忽略部分页面自动采集

3.3 统计事件

3.4 用户关联

3.5 用户属性设置

属性名称

属性值

4. 更多接口

4.1 单独指定上报地址设置

4.1.1 设置数据上报地址

4.1.2 设置可视化埋点上报地址

4.2 用户属性

4.2.1 用户 ID 设置

4.2.2 设置用户固有属性

4.2.3 设置用户属性相对变化值

4.2.4 新增列表类型的属性

4.2.5 删除设置的属性

4.3 通用属性

属性名称

属性值

4.3.1 注册通用属性

4.3.2 删除通用属性

4.3.3 获取通用属性

4.4 SDK 发送策略

4.4.1 设置上传间隔时间

4.4.2 设置事件最大上传条数

4.4.3 本地缓存上限值

4.4.4 手动上传

4.5 清除本地设置

5. 消息推送

5.1 简介

5.2 设置设备推送 ID

5.2.1 极光推送

5.2.2 百度推送

5.2.3 小米推送

5.2.4 个推推送

5.3 统计活动推广信息

5.4 三方推送平台 SDK 集成及示例代码

5.4.1 极光推送

5.4.2 百度推送

5.4.3 小米推送

5.4.4 个推推送