基础集成

1. 域名设置

在初始化之前,开发者需要在调用SDK任意其它接口之前最先调用setCustomDomain接口设置私有化环境收数域名。

接口:

/** 设置上报统计日志的主域名和备用域名。此函数必须在SDK初始化函数调用之前调用。
*
@param primaryDomain 传日志的主域名收数地址,参数不能为null或者空串。
@param standbyDomain 上传日志备用域名收数地址,参数可以为null或者空串,若此参数为空,SDK内部会自动将主域名设置为备用域名。
*/

+ (void)setCustomDomain:(NSString *)primaryDomain standbyDomain:(NSString *)standbyDomain;

参数:

参数

类型

描述

备注

primaryDomain

NSString

主域名

必需设置

standbyDomain

NSString

备用域名

可选

APM稳定性库相关域名接口:

+ (void)setLogUploadUrl:(NSString* _Nonnull)uploadUrl;

参数

含义

备注

uploadUrl

上传稳定性日志的域名收数地址。

v2.1.0 及以上版本支持

APM性能库相关域名接口:

+ (void) setLogUploadUrl: (NSString *) uploadUrl;

参数

含义

备注

uploadUrl

上传性能日志的域名收数地址。

v2.1.0 及以上版本支持

示例:

#import <UMAPM/UMAPMConfig.h>
#import <UMAPM/UMCrashConfigure.h>
#import <UMEFS/UMEFS.h>
#import <UMEFS/UMEFSConfig.h>
#import <UMEFS/UMEFSConfigure.h>
#import <QTCommon/QTCommon.h>
#import <UMCommonLog/UMCommonLogManager.h> //引入日志包时需要添加

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

    UMAPMConfig* config = [UMAPMConfig defaultConfig];   
    config.crashAndBlockMonitorEnable = YES;
    [UMCrashConfigure setAPMConfig:config];

    UMEFSConfig* configForEFS = [UMEFSConfig defaultConfig];
    configForEFS.networkEnable = YES;
    configForEFS.launchMonitorEnable = YES;
    configForEFS.memMonitorEnable = YES;
    configForEFS.javaScriptBridgeEnable = YES;
    configForEFS.oomMonitorEnable = YES;
    configForEFS.pageMonitorEnable = YES;
    configForEFS.logCollectEnable = YES;
    configForEFS.logCollectUserId = @"user1";
    configForEFS.initSendPVEnable = YES;
    [UMEFSConfigure setAPMConfig:configForEFS];

    [QTConfigure setCustomDomain:@"您的收数服务域名" standbyDomain:@""];
    [QTConfigure initWithAppkey:@"您的appkey" channel:@"App Store"];
    
    /**
     * 如果需要单独设置APM收数域名,请通过以下接口设置
     * [UMCrashConfigure setLogUploadUrl:@"您的收数服务域名"]; //v2.1.0 及以上版本支持
     * [UMEFSConfigure setLogUploadUrl:@"您的收数服务域名"]; //v2.1.0 及以上版本支持
     * [QTConfigure initWithAppkey:@"您的appkey" channel:@"App Store" shouldPluginsTrackDomainIndepent:YES]; //v1.5.6.PX 及以上版本支持
     */
  
    return YES;
}

请注意:如果数据统计和性能体验使用的是一个收数域名,那么仅需要设置:"[QTConfigure setCustomDomain:@"您的收数服务域名" standbyDomain:@""];" 即可。

2. 设置用户标识(可选)

接口

+ (void)profileSignInWithPUID:(NSString *)puid;
+ (void)profileSignOff;

参数:

参数

类型

描述

备注

puid

NSString

用户ID

示例:

[QTMobClick profileSignInWithPUID:@"UserID"];

3. 初始化

3.1 初始化接口

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

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

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

3.2. Appkey获取

在产品的 “管理控制台” -> “应用管理” 中,找到您的应用获取。

4. 开启日志

接口:

+ (void)setLogEnable:(BOOL)enable;

如果需要查看SDK初始化阶段的日志,请在初始化之前设置开启日志,建议在调用设置收数域名和初始化SDK接口之前开启。

头文件:

#import <UMEFS/WPKLog.h>

示例:

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    
    [UMCommonLogManager setUpUMCommonLogManager];
    [QTConfigure setLogEnabled:YES];//设置打开数据统计日志
    [WPKLog setLogEnable:YES];//设置打开性能体验日志
    [QTConfigure setCustomDomain:@"您的收数服务域名" standbyDomain:nil];//设置收数域名
    [QTConfigure initWithAppkey:@"您的appkey" channel:@"App Store"];
}