基础集成

macOS SDK合规

合规声明

  • 工信部的合规要求应用APP在用户同意隐私政策前不可以获取任何个人信息,因此您需要在您的应用首次启动时弹出《隐私政策》征得用户同意。

  • 您务必告知您的用户,您APP集成了QuickTracking SDK服务,并在《隐私政策》中增加如下参考条款:

    • 我们的产品集成Quick Tracking SDK,Quick Tracking SDK需要收集您的OS/OSVERSION/TIMEZONE/LANGUAGE/RESOLUTION/设备厂商/设备型号/设备品牌/网络以提供统计分析服务。

  • 您务必确保您的用户同意了《隐私政策》后,再初始化QuickTracking SDK,否则如果用户不同意《隐私政策》授权,则不能初始化QuickTracking SDK。

SDK 初始化

注意:需要在 程序入口主线程 初始化 SDK,否则可能会丢失部分事件数据。

获取appkey

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

获取收数域名

收数域名是SDK上报日志的域名服务器地址,在 "QuickTracking管理后台--管理控制台--采集信息--收数域名" 获取

SDK 初始化

#import <QuickTrackingSDK/QuickTrackingSDK.h>

- (void)applicationDidFinishLaunching:(NSNotification *)aNotification {
    QTSDKConfig *sdkConfig;
    // 初始化SDK配置
    sdkConfig = [[QTSDKConfig alloc] initWithAppkey:@"您的应用唯一标识"
                                        trackDomain:@"https://您的收数域名"
                                      launchOptions:nil];
                                      
    // 设置应用发布渠道,例如:appstore
    sdkConfig.channel = @"您的应用发布渠道";
    
    // 设置批量发送最小时间间隔(毫秒),默认3s
    sdkConfig.batchSendInterval = 3000;
    
    // 开启 SDK日志打印,默认关闭
    sdkConfig.enableLog = YES; 
    
    // 确保 SDK 不被禁用,默认为 NO
    // sdkConfig.disableSDK = NO;
    
    // App 进入后台时等待数据发送结果,默认为 NO
    // sdkConfig.enableSendLogsBeforeEnterBackground = YES;
    
    // “QuickTracking管理后台--数据采集--埋点验证--PC应用验证” 标识
    // sdkConfig.debugKey = @"97052112091876_xxxxx";
    
    // 设置本地缓存事件条数上限,默认值为10000条,超过部分删除处理
    // sdkConfig.maxCacheSize = 10000;
      
    // 是否开启H5桥接事件监听,默认关闭
    // sdkConfig.enableJSBridge = YES;
    
    // 初始化 SDK
    [QuickTrackingSDK initWithConfig:sdkConfig];
}

QTSDKConfig参数说明

参数

类型

描述

是否必填

appkey

nonnull NSString

应用的唯一编码,即应用的 appkey。

trackDomain

nonnull NSString

数据收集的域名,用于确定数据发送的目的地。

launchOptions

nullable id

启动选项,这通常包含应用启动时的配置属性(可以为 nil)。

QTSDKConfig属性列表

参数

类型

描述

是否必填

batchSendInterval

NSInteger

两次数据发送的最小时间间隔,单位毫秒。默认值为 3 秒,最小值为3秒。

maxCacheSize

NSInteger

本地缓存事件条数上限,默认值为10000条,超过部分删除处理。

batchSendQueueSize

NSInteger

触发上传的缓存日志上限,默认值为 100,注意设置的值过大会导致网络请求丢包。

enableLog

BOOL

是否开启日志打印。默认值为 NO。

disableSDK

BOOL

是否禁用 SDK,默认值为 NO。禁用后SDK 将不会触发事件,也不会发送网络请求。

enableSendLogsBeforeEnterBackground

BOOL

App 进入后台时是否等待数据发送结果。默认值为 NO。设置 YES 会等待数据发送结果。

cacheFilePath

NSString

自定义埋点数据存储路径。此路径仅适用于 macOS 开发环境。

channel

NSString

应用发布渠道,用于标识应用的发布渠道信息。

debugKey

NSString

埋点验证标识,用于在验证数据流程中提供确认标识。

enableJSBridge

Boolean

H5桥接开关,用于监听H5桥接事件,默认关闭