Класс AMAAppMetricaConfiguration
- Методы экземпляра
- Свойства
- Описание методов
- Описание свойств
- APIKey
- accurateLocationTracking
- allowsBackgroundLocationUpdates
- appBuildNumber
- appEnvironment
- appOpenTrackingEnabled
- appVersion
- customHosts
- customLocation
- dataSendingEnabled
- dispatchPeriod
- handleActivationAsSessionStart
- handleFirstActivationAsUpdate
- locationTracking
- logsEnabled
- maxReportsCount
- maxReportsInDatabaseCount
- preloadInfo
- revenueAutoTrackingEnabled
- sessionTimeout
- sessionsAutoTracking
- userProfileID
Класс содержит расширенную стартовую конфигурацию библиотеки.
Параметры расширенной конфигурации применяются с момента инициализации библиотеки.
Методы экземпляра
Инициализирует экземпляр класса |
Свойства
API key приложения. |
|
Включить/отключить точный поиск местоположения для внутреннего менеджера местоположений. |
|
Включить/отключить фоновое отслеживание обновлений местоположения. |
|
Установите произвольный номер сборки приложения для отчета AppMetrica. |
|
Устанавливает окружение приложения для всех событий с момента активации. |
|
Включает/выключает автоматический сбор и отправку информации о запуске приложения через deeplink. |
|
Версия приложения. |
|
Установите URL-адреса прокси-серверов для AppMetrica, которые будут использоваться для startup запросов. |
|
Устанавливает собственную информацию о местоположении устройства. |
|
Включает/отключает отправку статистики на сервер AppMetrica. |
|
Установите пользовательский период отправки. Интервал в секундах между отправкой событий на сервер. |
|
Определяет инициализацию AppMetrica как начало пользовательской сессии. По умолчанию опция отключена. |
|
Определяет первый запуск приложения как обновление. |
|
Включает/отключает отправку информации о местоположении устройства. |
|
Включает/отключает логирование работы библиотеки. |
|
Установите максимальное количество сохраненных событий. |
|
Максимальное число отчетов об ошибках, которое хранится во внутренней БД. |
|
Устанавливает объект класса AMAAppMetricaPreloadInfo для отслеживания предустановленных приложений. |
|
Включает/выключает автоматический сбор информации об In-App покупках. |
|
Задает длительность таймаута сессии в секундах. |
|
Включает/отключает автоматическое отслеживание жизненного цикла приложений. |
|
Задает идентификатор пользовательского профиля ( |
Описание методов
-initWithAPIKey:
- (instancetype)initWithAPIKey:(NSString *)APIKey
Инициализирует экземпляр класса AMAAppMetricaConfiguration
с указанным API key.
Параметры:
|
API key приложения. |
Возвращает:
Объект класса AMAAppMetricaConfiguration
.
Описание свойств
APIKey
@property (nonatomic, copy, readonly) NSString *APIKey;
API key приложения.
accurateLocationTracking
@property (nonatomic, assign) BOOL accurateLocationTracking;
Включить/отключить точный поиск местоположения для внутреннего диспетчера местоположений. По умолчанию отключено.
Действует только в том случае, если включено отслеживание местоположения YES
и местоположение не задано вручную.
allowsBackgroundLocationUpdates
@property (nonatomic, assign) BOOL allowsBackgroundLocationUpdates;
Включить/отключить отслеживание фоновых обновлений местоположения. По умолчанию отключено.
Чтобы включить отслеживание фоновых обновлений местоположения, установите для свойства значение YES
.
appBuildNumber
@property (nonatomic, copy, nullable) NSString *appBuildNumber;
Установите произвольный номер сборки приложения для отчета AppMetrica.
Если он не задан, AppMetrica будет использовать номер сборки приложения, указанный в файле конфигурации приложения Info.plist
(CFBundleVersion
).
Значение номера сборки должно быть числовой строкой, которая может быть преобразована в положительное целое число.
appEnvironment
@property (nonatomic, copy, nullable) NSDictionary<NSString *, NSString *> *appEnvironment;
Устанавливает окружение приложения для всех событий с момента активации.
appOpenTrackingEnabled
@property (nonatomic, assign) BOOL appOpenTrackingEnabled;
Включает/выключает автоматический сбор и отправку информации о запуске приложения через deeplink.
Внимание
Начиная с версии AppMetrica SDK iOS 4.0, отслеживание открытия приложения через deeplink работает автоматически. Для остальных вариантов настройте отслеживание вручную:
- Версия AppMetrica SDK iOS ниже 4.0. Настройка отслеживания deeplink для UIApplicationDelegate.
- Настройка отслеживания deeplink для UISceneDelegate (AppMetrica не отслеживает такие открытия автоматически).
Автоматическое отслеживание будет фиксировать только те deeplink, которые привели к запуску приложения. Для отслеживания deeplink внутри запущенного приложения дополнительно настройте отслеживание.
По умолчанию опция включена.
Возможные значения:
YES
— режим автоматического сбора и отправки данных о запуске приложения через deeplink включен.NO
— режим автоматического сбора и отправки данных о запуске приложения через deeplink выключен.
appVersion
@property (nonatomic, copy, nullable) NSString *appVersion;
Версия приложения.
customHosts
@property (nonatomic, copy, nullable) NSArray *customHosts;
Установите URL-адреса прокси-серверов для AppMetrica, которые будут использоваться для startup запросов.
customLocation
@property (nonatomic, strong, nullable) CLLocation *customLocation;
dataSendingEnabled
@property (nonatomic, assign) BOOL dataSendingEnabled;
Устанавливает собственную информацию о местоположении устройства.
dispatchPeriod
@property (nonatomic, assign) NSUInteger dispatchPeriod;
Установите пользовательский период отправки. Интервал в секундах между отправкой событий на сервер.
По умолчанию 90 секунд. Установка значения 0 секунд предотвращает автоматическую отправку событий библиотекой с использованием таймера.
handleActivationAsSessionStart
@property (nonatomic, assign) BOOL handleActivationAsSessionStart;
Определяет инициализацию AppMetrica как начало пользовательской сессии.
По умолчанию опция отключена.
Возможные значения:
YES
— пользовательская сессия создается в момент инициализации библиотеки.NO
— в момент инициализации библиотеки создается фоновая сессия, а пользовательская сессия создается после системного события UIApplicationDidBecomeActiveNotification.
handleFirstActivationAsUpdate
@property (nonatomic, assign) BOOL handleFirstActivationAsUpdate;
Определяет первый запуск приложения как обновление.
Примечание
Если первый запуск приложения определяется как обновление, то установка не будет отображаться в отчетах как новая установка и не будет атрибутироваться партнерам.
Возможные значения:
YES
— первый запуск определяется как обновление.NO
— первый запуск определяется как новая установка.
locationTracking
@property (nonatomic, assign) BOOL locationTracking;
Включает/отключает отправку информации о местоположении устройства.
По умолчанию отправка включена.
logsEnabled
@property (nonatomic, assign, getter=areLogsEnabled) BOOL logsEnabled;
Включает/отключает логирование работы библиотеки.
По умолчанию логирование выключено.
maxReportsCount
@property (nonatomic, assign) NSUInteger maxReportsCount;
Установите максимальное количество сохраненных событий. Минимальное количество кэшированных событий, которое приводит к автоматической отправке отчетов.
По умолчанию события отправляются автоматически, когда в хранилище имеется не менее 7 элементов.
Установка значения 0 предотвращает автоматическую отправку событий библиотекой при достижении заданного количества событий в хранилище.
maxReportsInDatabaseCount
@property (nonatomic, assign) NSUInteger maxReportsInDatabaseCount;
Максимальное число отчетов об ошибках, которое хранится во внутренней БД.
Допускаются значения в интервале [100; 10000]. Значения, не попадающие в данный интервал, будут автоматически заменены на значение ближайшей границы интервала.
Значение по умолчанию — 1000.
Примечание
Для различных apiKey
используются отдельные БД и для них могут быть установлены независимые ограничения числа событий. Данный параметр влияет на ограничение только для соответствующего apiKey
. Чтобы изменить максимально допустимое число событий для других apiKey
, используйте AMAReporterConfiguration.maxReportsInDatabaseCount.
preloadInfo
@property (nonatomic, copy, nullable) AMAAppMetricaPreloadInfo *preloadInfo;
Устанавливает объект класса AMAAppMetricaPreloadInfo для отслеживания предустановленных приложений.
Подробнее в разделе Трекинг предустановленных приложений.
revenueAutoTrackingEnabled
@property (nonatomic, assign) BOOL revenueAutoTrackingEnabled;
Включает/выключает автоматический сбор информации об In-App покупках.
По умолчанию опция включена.
Возможные значения:
YES
— режим автоматического сбора и отправки информации об In-App покупках включен.NO
— режим автоматического сбора и отправки информации об In-App покупках выключен.
sessionTimeout
@property (nonatomic, assign) NSUInteger sessionTimeout;
Задает длительность таймаута сессии в секундах.
Значение по умолчанию — 10
(минимально допустимое значение).
Подробнее о сессиях в разделе Отслеживание активности пользователей.
sessionsAutoTracking
@property (nonatomic, assign) BOOL sessionsAutoTracking;
Включает/отключает автоматическое отслеживание жизненного цикла приложений.
По умолчанию опция включена.
Если опция выключена, необходимо вручную настроить контроль продолжительности сессии с использованием методов +pauseSession: и +resumeSession:. Подробнее в разделе Отслеживание сессий вручную.
Для отслеживания сессий AppMetrica использует UIApplicationDidBecomeActiveNotification и UIApplicationWillResignActiveNotification. Максимальная длительность сессии — 24 часа. Чтобы продлить сессию после 24 часов, необходимо вызвать метод +resumeSession: вручную.
userProfileID
@property (nonatomic, copy, nullable) NSString *userProfileID;
Задает идентификатор пользовательского профиля (ProfileID
) при активации.
Внимание
Максимальная длина строки ProfileID
— 200 символов.