--- metadata: - name: generator content: Diplodoc Platform v5.54.2 alternate: - https://appmetrica.yandex.by/docs/en/sdk/ios/analytics/swift/AppMetricaConfiguration.md - https://appmetrica.yandex.by/docs/ru/sdk/ios/analytics/swift/AppMetricaConfiguration.md - href: ru/sdk/ios/analytics/swift/AppMetricaConfiguration.md type: text/markdown title: Markdown version - href: ../../../../llms.txt type: text/markdown title: llms.txt --- > **Documentation Index:** Fetch the complete configuration index at https://appmetrica.yandex.by/docs/ru/llms.txt # Класс AppMetricaConfiguration Класс содержит расширенную стартовую конфигурацию библиотеки. Параметры расширенной конфигурации применяются с момента инициализации библиотеки. ## Методы экземпляра {#instance_summary} #| || [init?(apiKey:)](#method_initWithApiKey) | Инициализирует экземпляр класса `AppMetricaConfiguration` с указанным API key. || |# ## Свойства {#property_summary} #| || [accurateLocationTracking](#property_accurateLocationTracking) | Включить/отключить точный поиск местоположения для внутреннего менеджера местоположений. || || [allowsBackgroundLocationUpdates](#property_allowsBackgroundLocationUpdates) | Включить/отключить фоновое отслеживание обновлений местоположения. || || [apiKey](#property_APIKey) | API key приложения. || || [appBuildNumber](#property_appBuildNumber) | Установите произвольный номер сборки приложения для отчета AppMetrica. || || [appEnvironment](#property_appEnvironment) | Устанавливает окружение приложения для всех событий с момента активации. || || [appOpenTrackingEnabled](#property_appOpenTrackingEnabled) | Включает/выключает автоматический сбор и отправку информации о запуске приложения через deeplink. || || [appVersion](#property_appVersion) | Версия приложения. || || [areLogsEnabled](#property_areLogsEnabled) | Включает/отключает логирование работы библиотеки. || || [customHosts](#property_customHosts) | Установите URL-адреса прокси-серверов для AppMetrica, которые будут использоваться для startup запросов. || || [customLocation](#property_customLocation) | Устанавливает собственную информацию о местоположении устройства. || || [dataSendingEnabled](#property_dataSendingEnabled) | Включает/отключает отправку статистики на сервер AppMetrica. || || [dispatchPeriod](#property_dispatchPeriod) | Установите пользовательский период отправки. Интервал в секундах между отправкой событий на сервер. || || [handleActivationAsSessionStart](#property_handleActivationAsSessionStart) | Определяет инициализацию AppMetrica как начало пользовательской сессии. По умолчанию опция отключена. || || [handleFirstActivationAsUpdate](#property_handleFirstActivationAsUpdate) | Определяет первый запуск приложения как обновление. || || [locationTracking](#property_locationTracking) | Включает/отключает отправку информации о местоположении устройства. || || [maxReportsCount](#property_maxReportsCount) | Установите максимальное количество сохраненных событий. || || [maxReportsInDatabaseCount](#property_maxReportsInDatabaseCount) | Максимальное число отчетов об ошибках, которое хранится во внутренней БД. || || [preloadInfo](#property_preloadInfo) | Устанавливает объект класса [AppMetricaPreloadInfo](https://appmetrica.yandex.by/docs/ru/sdk/ios/analytics/swift/AppMetricaPreloadInfo.md) для отслеживания предустановленных приложений. || || [revenueAutoTrackingEnabled](#property_revenueAutoTrackingEnabled) | Включает/выключает автоматический сбор информации об In-App покупках. || || [sessionTimeout](#property_sessionTimeout) | Задает длительность таймаута сессии в секундах. || || [sessionsAutoTracking](#property_sessionsAutoTracking) | Включает/отключает автоматическое отслеживание жизненного цикла приложений. || || [userProfileID](#property_userProfileID) | Задает идентификатор пользовательского профиля (`ProfileID`) при активации. || |# ## Описание методов {#method_detail} ### init?(apiKey:) {#method_initWithApiKey} ```swift translate=no public init?(apiKey: String) ``` Инициализирует экземпляр класса `AppMetricaConfiguration` с указанным API key. **Параметры:** #| || `apiKey` | API key приложения. || |# **Возвращает:** Объект класса `AppMetricaConfiguration`. ## Описание свойств {#property_detail} ### accurateLocationTracking {#property_accurateLocationTracking} ```swift translate=no var accurateLocationTracking: Bool { get; set; } ``` Включить/отключить точный поиск местоположения для внутреннего диспетчера местоположений. По умолчанию отключено. Действует только в том случае, если включено отслеживание местоположения `true` и местоположение не задано вручную. ### allowsBackgroundLocationUpdates {#property_allowsBackgroundLocationUpdates} ```swift translate=no var allowsBackgroundLocationUpdates: Bool { get; set; } ``` Включить/отключить отслеживание фоновых обновлений местоположения. По умолчанию отключено. Чтобы включить отслеживание фоновых обновлений местоположения, установите для свойства значение `true`. ### apiKey {#property_APIKey} ```swift translate=no var apiKey: String { get; } ``` API key приложения. ### appBuildNumber {#property_appBuildNumber} ```swift translate=no var appBuildNumber: String? { get; set; } ``` Установите произвольный номер сборки приложения для отчета AppMetrica. Если он не задан, AppMetrica будет использовать номер сборки приложения, указанный в файле конфигурации приложения `Info.plist` (`CFBundleVersion`). Значение номера сборки должно быть числовой строкой, которая может быть преобразована в положительное целое число. ### appEnvironment {#property_appEnvironment} ```swift translate=no var appEnvironment: [String : String]? { get; set; } ``` Устанавливает окружение приложения для всех событий с момента активации. ### appOpenTrackingEnabled {#property_appOpenTrackingEnabled} ```swift translate=no var appOpenTrackingEnabled: Bool { get; set; } ``` Включает/выключает автоматический сбор и отправку информации о запуске приложения через deeplink. {% note alert %} Начиная с версии AppMetrica SDK iOS 4.0, отслеживание открытия приложения через deeplink работает автоматически. Для остальных вариантов настройте отслеживание вручную: - Версия AppMetrica SDK iOS ниже 4.0. [Настройка](https://appmetrica.yandex.by/docs/ru/sdk/ios/analytics/ios-operations.md#ui-app-delegate) отслеживания deeplink для UIApplicationDelegate. - [Настройка](https://appmetrica.yandex.by/docs/ru/sdk/ios/analytics/ios-operations.md#ui-scene-delegate) отслеживания deeplink для UISceneDelegate (AppMetrica не отслеживает такие открытия автоматически). Автоматическое отслеживание будет фиксировать только те deeplink, которые привели к запуску приложения. Для отслеживания deeplink внутри запущенного приложения дополнительно настройте [отслеживание](https://appmetrica.yandex.by/docs/ru/sdk/ios/analytics/ios-operations.md). {% endnote %} По умолчанию опция включена. Возможные значения: - `true` — режим автоматического сбора и отправки данных о запуске приложения через deeplink включен. - `false` — режим автоматического сбора и отправки данных о запуске приложения через deeplink выключен. ### appVersion {#property_appVersion} ```swift translate=no var appVersion: String? { get; set; } ``` Версия приложения. ### areLogsEnabled {#property_areLogsEnabled} ```swift translate=no var areLogsEnabled: Bool { get; set; } ``` Включает/отключает логирование работы библиотеки. По умолчанию логирование выключено. ### customHosts {#property_customHosts} ```swift translate=no var customHosts: [Any]? { get; set; } ``` Установите URL-адреса прокси-серверов для AppMetrica, которые будут использоваться для startup запросов. ### customLocation {#property_customLocation} ```swift translate=no var customLocation: CLLocation? { get; set; } ``` ### dataSendingEnabled {#property_dataSendingEnabled} ```swift translate=no var dataSendingEnabled: Bool { get; set; } ``` Устанавливает собственную информацию о местоположении устройства. ### dispatchPeriod {#property_dispatchPeriod} ```swift translate=no var dispatchPeriod: UInt { get; set; } ``` Установите пользовательский период отправки. Интервал в секундах между отправкой событий на сервер. По умолчанию 90 секунд. Установка значения 0 секунд предотвращает автоматическую отправку событий библиотекой с использованием таймера. ### handleActivationAsSessionStart {#property_handleActivationAsSessionStart} ```swift translate=no vat handleActivationAsSessionStart: Bool { get; set; } ``` Определяет инициализацию AppMetrica как начало пользовательской сессии. По умолчанию опция отключена. Возможные значения: - `true` — пользовательская сессия создается в момент инициализации библиотеки. - `false` — в момент инициализации библиотеки создается фоновая сессия, а пользовательская сессия создается после системного события [UIApplicationDidBecomeActiveNotification](https://developer.apple.com/documentation/uikit/uiapplicationdidbecomeactivenotification). ### handleFirstActivationAsUpdate {#property_handleFirstActivationAsUpdate} ```swift translate=no var handleFirstActivationAsUpdate: Bool { get; set; } ``` Определяет первый запуск приложения как обновление. {% note info %} Если первый запуск приложения определяется как обновление, то установка не будет отображаться в отчетах как новая установка и не будет атрибутироваться партнерам. {% endnote %} Возможные значения: - `true` — первый запуск определяется как обновление. - `false` — первый запуск определяется как новая установка. ### locationTracking {#property_locationTracking} ```swift translate=no var locationTracking: Bool { get; set; } ``` Включает/отключает отправку информации о местоположении устройства. По умолчанию отправка включена. ### maxReportsCount {#property_maxReportsCount} ```swift translate=no var maxReportsCount: UInt { get; set; } ``` Установите максимальное количество сохраненных событий. Минимальное количество кэшированных событий, которое приводит к автоматической отправке отчетов. По умолчанию события отправляются автоматически, когда в хранилище имеется не менее 7 элементов. Установка значения 0 предотвращает автоматическую отправку событий библиотекой при достижении заданного количества событий в хранилище. ### maxReportsInDatabaseCount {#property_maxReportsInDatabaseCount} ```swift translate=no var maxReportsInDatabaseCount: UInt { get; set; } ``` Максимальное число отчетов об ошибках, которое хранится во внутренней БД. Допускаются значения в интервале [100; 10000]. Значения, не попадающие в данный интервал, будут автоматически заменены на значение ближайшей границы интервала. Значение по умолчанию — 1000. {% note info %} Для различных `apiKey` используются отдельные БД и для них могут быть установлены независимые ограничения числа событий. Данный параметр влияет на ограничение только для соответствующего `apiKey`. Чтобы изменить максимально допустимое число событий для других `apiKey`, используйте [ReporterConfiguration.maxReportsInDatabaseCount](https://appmetrica.yandex.by/docs/ru/sdk/ios/analytics/swift/ReporterConfiguration.md#property_maxReportsInDatabaseCount). {% endnote %} ### preloadInfo {#property_preloadInfo} ```swift translate=no var preloadInfo: AppMetricaPreloadInfo? { get; set; } ``` Устанавливает объект класса [AppMetricaPreloadInfo](https://appmetrica.yandex.by/docs/ru/sdk/ios/analytics/swift/AppMetricaPreloadInfo.md) для отслеживания предустановленных приложений. Подробнее в разделе [Трекинг предустановленных приложений](https://appmetrica.yandex.by/docs/ru/mobile-tracking/preinstalled-app-attr.md). ### revenueAutoTrackingEnabled {#property_revenueAutoTrackingEnabled} ```swift translate=no var revenueAutoTrackingEnabled: Bool { get; set; } ``` Включает/выключает автоматический сбор информации об In-App покупках. По умолчанию опция включена. Возможные значения: - `true` — режим автоматического сбора и отправки информации об In-App покупках включен. - `false` — режим автоматического сбора и отправки информации об In-App покупках выключен. ### sessionTimeout {#property_sessionTimeout} ```swift translate=no var sessionTimeout: UInt ``` Задает длительность таймаута сессии в секундах. Значение по умолчанию — `10` (минимально допустимое значение). Подробнее о сессиях в разделе [Отслеживание активности пользователей](https://appmetrica.yandex.by/docs/ru/sdk/ios/analytics/ios-listen.md). ### sessionsAutoTracking {#property_sessionsAutoTracking} ```swift translate=no var sessionsAutoTracking: Bool { get; set; } ``` Включает/отключает автоматическое отслеживание жизненного цикла приложений. По умолчанию опция включена. Если опция выключена, необходимо вручную настроить контроль продолжительности сессии с использованием методов [pauseSession()](https://appmetrica.yandex.by/docs/ru/sdk/ios/analytics/swift/AppMetrica.md#method_pauseSession) и [resumeSession()](https://appmetrica.yandex.by/docs/ru/sdk/ios/analytics/swift/AppMetrica.md#method_resumeSession). Подробнее в разделе [Отслеживание сессий вручную](https://appmetrica.yandex.by/docs/ru/sdk/ios/analytics/ios-listen.md). Для отслеживания сессий AppMetrica использует [UIApplicationDidBecomeActiveNotification](https://developer.apple.com/documentation/uikit/uiapplicationdidbecomeactivenotification) и [UIApplicationWillResignActiveNotification](https://developer.apple.com/documentation/uikit/uiapplicationwillresignactivenotification). Максимальная длительность сессии — 24 часа. Чтобы продлить сессию после 24 часов, необходимо вызвать метод [resumeSession()](https://appmetrica.yandex.by/docs/ru/sdk/ios/analytics/swift/AppMetrica.md#method_resumeSession) вручную. ### userProfileID {#property_userProfileID} ```swift translate=no var userProfileID: String? { get; set; } ``` Задает идентификатор пользовательского профиля (`ProfileID`) при активации. {% note alert %} Максимальная длина строки `ProfileID` — 200 символов. {% endnote %}