阿里云首页 Quick Tracking

基础集成

1623720669037-65cb6577-6982-424c-bf1e-2dbf72950044

1 域名设置

接口:

/** 设置上报统计日志的主域名和备用域名。此函数必须在SDK初始化函数调用之前调用。
 
 @param primaryDomain 传日志的主域名收数地址,参数不能为null或者空串。例如:https://www.umeng.com
 @param standbyDomain 上传日志备用域名收数地址,参数可以为null或者空串,若此参数为空,SDK内部会自动将主域名设置为备用域名。
*/
+ (void)setCustomDomain:(NSString *)primaryDomain standbyDomain:(NSString *)standbyDomain;

参数:

参数

类型

描述

备注

primaryDomain

NSString

主域名

必需设置

standbyDomain

NSString

备用域名

可选

提示

此方法需要初始化方法之前调用

2 合规初始化

2.1 初始化接口

1、合规声明

您务必告知用户您选择Quick Tracking SDK服务,请在《隐私政策》中增加如下参考条款:

“我们的产品集成Quick Tracking SDK,Quick Tracking SDK需要收集您的设备Mac地址、唯一设备识别码(IMEI/android ID/IDFA/OPENUDID/GUID、SIM 卡 IMSI 信息)以提供统计分析服务,并通过地理位置校准报表数据准确性,提供基础反作弊能力。”

2、合规初始化

为保证您的App在集成【Quick Tracking】统计SDK之后,能够满足工信部相关合规要求,您应确保App首次冷启动时,在用户阅读您的《隐私政策》并取得用户授权之后,才调用正式初始化函数初始化统计SDK,此时SDK才会真正采集设备信息并上报数据。反之,如果用户不同意《隐私政策》授权,则不能调用初始化函数。

/** 初始化Quick Tracking所有组件产品
 @param appKey 开发者在Quick Tracking产品中申请的appkey.
 @param channel 渠道标识,可设置nil表示"App Store".
 */
+ (void)initWithAppkey:(NSString *)appKey channel:(NSString *)channel;

一旦App获取到《隐私政策》的用户授权,后续的App冷启动,开发者应该保证调用到初始化函数。

2.2 Appkey获取

在初始化SDK时,需要填写参数Appkey。Appkey是在Quick Tracking中代表应用的唯一ID,在创建应用时生成,其获取或查看方法详见文档:应用管理

2.3 渠道设置

命名规则:

  • 可以由英文字母、阿拉伯数字、下划线、中划线、空格、括号组成,可以含汉字以及其他明文字符,但是不建议使用中文命名,会出现乱码。

  • 首尾字符不可以为空格

  • 最多256个字符

  • "App Store" 及其各种大小写形式,作为Quick Tracking保留的字段,不可以作为渠道名。

3 日志打印

iOS中,日志模块为独立的插件,需要集成后才可以使用。

3.1 日志插件引入

1、选择SDK功能组件并下载,解压.zip文件得到相应组件包(例如:UMCommonLog.framework,UMCommonLog.bundle)。

2、XcodeFile —>Add Files to"Your Project",在弹出Panel选中所下载组件包->Add。(注:选中“Copy items if needed”)

502F2D35-9594-4D56-BB3F-8895B3BB3D26D0A83A67-2331-4BE6-804A-42BE6A927A27

3.2 日志插件初始化

1、说明和用途

  • 设置是否在console输出sdk的log信息。

  • 日志库UMCommonLog.framework需要明确初始化才能被各个业务组件使用。

  • UMCommonLog.bundle为资源文件,必须加入到工程中,否则日志显示的内容会不正确。

2、接口函数

接口:

+(void) setUpUMCommonLogManager;

示例代码:

#import <UMCommonLog/UMCommonLogHeaders.h>
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Override point for customization after application launch.
    //开发者需要显式的调用此函数,日志系统才能工作
    [UMCommonLogManager setUpUMCommonLogManager];
}

3.3 开启日志

通过UMCommon.framwork的头文件UMConfigure.h接口API开启日志

接口:

/** 设置是否在console输出sdk的log信息.
 @param bFlag 默认NO(不输出log); 设置为YES, 输出可供调试参考的log信息. 发布产品时必须设置为NO.
 */
+ (void)setLogEnabled:(BOOL)bFlag;

示例:

#import <UMCommon/UMCommon.h>
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
//开发者需要显式的调用此函数,日志系统才能工作
[UMCommonLogManager setUpUMCommonLogManager];
[UMConfigure setLogEnabled:YES];//设置打开日志
[UMConfigure setCustomDomain:@"https://www.umeng.com" standbyDomain:nil];//设置域名
[UMConfigure initWithAppkey:@"Your appkey" channel:@"App Store"];
}

日志格式:

举例:如果用户传入的AppKey为空的话,打印日志如下图:

5FC51E40-553A-4836-BD91-F78B255A8094
  • 2018-02-08 20:19:44: 指当前的打印的时间;

  • UMengCommon: 指组件化SDK(UMCommon.framework)的名字;

  • <1.4.3>: 指组件化SDK(UMCommon.framework)的版本号;

  • (Error)[CIE10001]: 指日志的FAQ的代号,也可通过FAQ文档找到对应的解决方法;

  • 用户传入的AppKey不合法,请到官网申请AppKey,以免影响自己App的统计数据。: 指提示开发者的错误信息,帮助开发者找到错误原因。