AppMetricaConfiguration 类

此类包含库的扩展启动配置。

扩展配置的参数从库初始化时开始生效。

Instance methods

init?(apiKey:)

使用指定的API密钥初始化AppMetricaConfiguration类的实例。

Properties

精确位置跟踪

启用/禁用内部位置管理器的精确位置搜索。

allowsBackgroundLocationUpdates

启用/禁用后台跟踪位置更新。

apiKey

应用的API密钥。

appBuildNumber

为AppMetrica报告设置应用构建号。

应用环境

设置应用环境,从激活时刻起应用于所有事件。

appOpenTrackingEnabled

启用/禁用通过深链自动收集和发送应用启动数据的功能。

appVersion

App版本。

areLogsEnabled

启用/禁用记录库的活动。

customHosts

设置用于AppMetrica启动查询的代理URL。

自定义位置

设置设备的自定义位置。

dataSendingEnabled

启用/禁用向 AppMetrica 服务器发送统计数据。

dispatchPeriod

设置自定义发送周期。 每次向服务器发送事件的间隔(秒)。

handleActivationAsSessionStart

定义 AppMetrica SDK 初始化为用户会话的开始。 此选项默认被禁用。

handleFirstActivationAsUpdate

将应用的首次启动定义为更新。

位置跟踪

启用/禁用发送设备位置。

maxReportsCount

设置存储事件的最大数量。

maxReportsInDatabaseCount

内部数据库中存储的错误报告最大数量。

preloadInfo

设置 AppMetricaPreloadInfo 类的实例,用于跟踪预安装的应用。

revenueAutoTrackingEnabled

启用/禁用自动收集应用内购买信息的功能。

sessionTimeout

设置会话超时时间(秒)。

sessionsAutoTracking

启用/禁用自动跟踪应用生命周期。

userProfileID

设置用户资料的ID(ProfileID)当激活时。

Method descriptions

init?(apiKey:)

public init?(apiKey: String)

使用指定的API密钥初始化AppMetricaConfiguration类的实例。

参数:

apiKey

应用程序的API密钥。

返回:

The AppMetricaConfiguration 类实例。

Property descriptions

accurateLocationTracking

var accurateLocationTracking: Bool { get; set; }

启用/禁用内部位置管理器的精确位置搜索。 默认禁用。

仅在位置跟踪设置为true且位置未手动设置时才生效。

allowsBackgroundLocationUpdates

var allowsBackgroundLocationUpdates: Bool { get; set; }

启用/禁用后台跟踪位置更新。 默认禁用。

要启用后台位置更新跟踪,将属性设置为true。

apiKey

var apiKey: String { get; }

应用程序的API密钥。

appBuildNumber

var appBuildNumber: String? { get; set; }

为 AppMetrica 报告设置应用构建号。

如果未设置,AppMetrica 将使用应用程序配置文件 Info.plist 中指定的应用构建号 (CFBundleVersion)。
应用构建号必须是一个数字字符串,可以转换为正整数。

appEnvironment

var appEnvironment: [String : String]? { get; set; }

设置应用环境,从激活时刻起应用于所有事件。

appOpenTrackingEnabled

var appOpenTrackingEnabled: Bool { get; set; }

启用/禁用通过深链自动收集和发送应用启动数据的功能。

注意

从 iOS 的 AppMetrica SDK 4.0 版开始,应用通过 deeplinks 打开时会自动进行跟踪。 对于其他版本,请手动设置跟踪:

  • iOS AppMetrica SDK 版本低于 4.0。 设置 UIApplicationDelegate 的深链追踪。
  • 设置 UISceneDelegate 的深链追踪(AppMetrica 不会自动追踪这种应用打开)。

自动跟踪仅捕获导致应用启动的深链。 要跟踪运行中的应用内的深链,还需要设置跟踪。

该选项默认已启用。

可能的值:

  • true: 已启用通过深链自动收集并发送应用启动数据的模式。
  • false: 自动收集并通过深链发送应用启动数据的功能已禁用。

appVersion

var appVersion: String? { get; set; }

App版本。

areLogsEnabled

var areLogsEnabled: Bool { get; set; }

启用/禁用记录库的活动。

默认情况下,日志记录已禁用。

customHosts

var customHosts: [Any]? { get; set; }

设置用于AppMetrica启动查询的代理URL。

customLocation

var customLocation: CLLocation? { get; set; }

dataSendingEnabled

var dataSendingEnabled: Bool { get; set; }

设置设备的自定义位置。

dispatchPeriod

var dispatchPeriod: UInt { get; set; }

设置自定义发送周期。 每次向服务器发送事件的间隔(秒)。

默认为90秒。 将值设置为 0 秒会防止库使用计时器自动发送事件。

handleActivationAsSessionStart

vat handleActivationAsSessionStart: Bool { get; set; }

定义 AppMetrica SDK 初始化为用户会话的开始。

此选项默认被禁用。

可能的值:

handleFirstActivationAsUpdate

var handleFirstActivationAsUpdate: Bool { get; set; }

将应用的首次启动定义为更新。

备注

如果将应用的首次启动定义为更新,那么安装不会在报告中显示为新安装,也不会归属于伙伴。

可能的值:

  • true: 首次启动被定义为更新。
  • false:第一次启动被定义为新安装。

locationTracking

var locationTracking: Bool { get; set; }

启用/禁用发送设备位置。

默认情况下,发送已启用。

maxReportsCount

var maxReportsCount: UInt { get; set; }

设置存储事件的最大数量。 自动发送报告的最小缓存事件数。

默认情况下,当存储中至少有7个项目时,事件会自动发送。

将值设置为 0 秒会防止库在存储中达到设定事件数量时自动发送事件。

maxReportsInDatabaseCount

var maxReportsInDatabaseCount: UInt { get; set; }

内部数据库中存储的错误报告最大数量。

允许的值范围是 [100; 10,000]。 超出此范围的值会自动替换为最接近范围边界的值。

默认值:1000。

备注

不同的数据库用于各个 apiKeys,并可为它们设置独立的事件数量限制。 该参数仅影响对应的apiKey的限制。 要修改其他 apiKeys 的最大允许事件数,请使用 ReporterConfiguration.maxReportsInDatabaseCount。

preloadInfo

var preloadInfo: AppMetricaPreloadInfo? { get; set; }

设置 AppMetricaPreloadInfo 类的实例,用于跟踪预安装的应用。

要了解更多信息,请查看跟踪预安装应用。

revenueAutoTrackingEnabled

var revenueAutoTrackingEnabled: Bool { get; set; }

启用/禁用自动收集应用内购买信息的功能。

该选项默认已启用。

可能的值:

  • true: 已启用应用内购买信息的自动收集和发送。
  • false: 自动收集和发送应用内购买信息已禁用。

sessionTimeout

var sessionTimeout: UInt

设置会话超时时间(秒)。
默认值是10(最小允许值)。

要了解有关会话的更多信息,请参见跟踪用户活动。

sessionsAutoTracking

var sessionsAutoTracking: Bool { get; set; }

启用/禁用自动跟踪应用生命周期。

该选项默认已启用。

如果该选项被禁用,您需要手动设置会话时长控制,使用 pauseSession() 和 resumeSession() 方法。 要了解更多信息,请参见手动会话跟踪。

AppMetrica 使用 UIApplicationDidBecomeActiveNotification 和 UIApplicationWillResignActiveNotification 来跟踪会话。 最大会话时长为 24 小时。 要在 24 小时后延长会话,请手动调用 resumeSession() 方法。

userProfileID

var userProfileID: String? { get; set; }

设置用户资料ID(ProfileID)在激活时。

注意

ProfileID 字符串的最大长度为 200 个字符。