Класс YMMYandexMetricaConfiguration

Класс содержит расширенную стартовую конфигурацию библиотеки.

Параметры расширенной конфигурации применяются с момента инициализации библиотеки.

Методы экземпляра

-initWithApiKey:

Инициализирует экземпляр класса YMMYandexMetricaConfiguration с указанным API key.
-initWithApiKey:

Инициализирует экземпляр класса YMMYandexMetricaConfiguration с указанным API key.

Свойства

apiKey

API key приложения.
appForKids

Определяет тип приложения как «детский», чтобы соответствовать правилам проверки детских приложений. Если опция включена, AppMetrica SDK не отправляет рекламные идентификаторы и информацию о местоположении.

Примечание. Используйте свойство, если ваше приложение относится к категории детских приложений.
appOpenTrackingEnabled

Включает/выключает автоматический сбор и отправку информации о запуске приложения через deeplink.
appVersion Версия приложения.
crashReporting Включает/отключает сбор и отправку информации об аварийных остановках приложения.
handleActivationAsSessionStart

Определяет инициализацию AppMetrica как начало пользовательской сессии.
handleFirstActivationAsUpdate Определяет первый запуск приложения как обновление.
maxReportsInDatabaseCount

Максимальное число отчетов об ошибках, которое хранится во внутренней БД.
location Устанавливает собственную информацию о местоположении устройства.
locationTracking Включает/отключает отправку информации о местоположении устройства.
logs

Включает/отключает логирование работы библиотеки.
preloadInfo

Устанавливает объект класса YMMYandexMetricaPreloadInfo для отслеживания предустановленных приложений.
revenueAutoTrackingEnabled

Включает/выключает автоматический сбор информации об In-App покупках.
sessionsAutoTracking

Включает/отключает автоматическое отслеживание жизненного цикла приложений.
sessionTimeout Задает длительность тайм-аута сессии в секундах.
statisticsSending Включает/отключает отправку статистики на сервер AppMetrica.
userProfileID

Задает идентификатор пользовательского профиля (ProfileID) при активации.
apiKey

API key приложения.
appForKids

Определяет тип приложения как «детский», чтобы соответствовать правилам проверки детских приложений. Если опция включена, AppMetrica SDK не отправляет рекламные идентификаторы и информацию о местоположении.

Примечание. Используйте свойство, если ваше приложение относится к категории детских приложений.
appOpenTrackingEnabled

Включает/выключает автоматический сбор и отправку информации о запуске приложения через deeplink.
appVersion Версия приложения.
crashReporting Включает/отключает сбор и отправку информации об аварийных остановках приложения.
handleActivationAsSessionStart

Определяет инициализацию AppMetrica как начало пользовательской сессии.
handleFirstActivationAsUpdate Определяет первый запуск приложения как обновление.
maxReportsInDatabaseCount

Максимальное число отчетов об ошибках, которое хранится во внутренней БД.
location Устанавливает собственную информацию о местоположении устройства.
locationTracking Включает/отключает отправку информации о местоположении устройства.
logs

Включает/отключает логирование работы библиотеки.
preloadInfo

Устанавливает объект класса YMMYandexMetricaPreloadInfo для отслеживания предустановленных приложений.
revenueAutoTrackingEnabled

Включает/выключает автоматический сбор информации об In-App покупках.
sessionsAutoTracking

Включает/отключает автоматическое отслеживание жизненного цикла приложений.
sessionTimeout Задает длительность тайм-аута сессии в секундах.
statisticsSending Включает/отключает отправку статистики на сервер AppMetrica.
userProfileID

Задает идентификатор пользовательского профиля (ProfileID) при активации.

Описание методов

-initWithApiKey:

- (instancetype)initWithApiKey:(NSString *)apiKey

Инициализирует экземпляр класса YMMYandexMetricaConfiguration с указанным API key.

Параметры:
apiKey API key приложения.
apiKey API key приложения.

Возвращает:

Объект класса YMMYandexMetricaConfiguration.

Описание свойств

apiKey

(nonatomic, copy, readonly) NSString *apiKey

API key приложения.

appForKids

(nonatomic, assign) BOOL appForKids

Определяет тип приложения как «детский», чтобы соответствовать правилам проверки детских приложений. Если опция включена, AppMetrica SDK не отправляет рекламные идентификаторы и информацию о местоположении.

Примечание. Используйте свойство, если ваше приложение относится к категории детских приложений.

appOpenTrackingEnabled

(nonatomic, assign) BOOL appOpenTrackingEnabled

Включает/выключает автоматический сбор и отправку информации о запуске приложения через deeplink.

Внимание. Автоматическое отслеживание будет фиксировать только те deeplink, которые привели к запуску приложения. Для отслеживания deeplink внутри запущенного приложения дополнительно настройте отслеживание.

По умолчанию опция включена.

Возможные значения:
  • YES — режим автоматического сбора и отправки данных о запуске приложения через deeplink включен.
  • NO — режим автоматического сбора и отправки данных о запуске приложения через deeplink выключен.

appVersion

(nonatomic, copy) NSString *appVersion

Версия приложения.

crashReporting

(nonatomic, assign) BOOL crashReporting

Включает/отключает сбор и отправку информации об аварийных остановках приложения.

Возможные значения:
  • YES — отправка информации об аварийных остановках включена.
  • NO — отправка информации об аварийных остановках выключена.

handleActivationAsSessionStart

(nonatomic, assign) BOOL handleActivationAsSessionStart

Определяет инициализацию AppMetrica как начало пользовательской сессии.

По умолчанию опция отключена.

Возможные значения:
  • YES — пользовательская сессия создается в момент инициализации библиотеки.
  • NO — в момент инициализации библиотеки создается фоновая сессия, а пользовательская сессия создается после системного события UIApplicationDidBecomeActiveNotification.

handleFirstActivationAsUpdate

(nonatomic, assign) BOOL handleFirstActivationAsUpdate

Определяет первый запуск приложения как обновление.

Примечание.

Если первый запуск приложения определяется как обновление, то установка не будет отображаться в отчетах как новая установка и не будет атрибутироваться партнерам.

Возможные значения:
  • YES — первый запуск определяется как обновление.
  • NO — первый запуск определяется как новая установка.

maxReportsInDatabaseCount

@property (assign, readwrite, nonatomic) NSUInteger maxReportsInDatabaseCount;

Максимальное число отчетов об ошибках, которое хранится во внутренней БД.

Допускаются значения в интервале [100; 10000]. Значения, не попадающие в данный интервал, будут автоматически заменены на значение ближайшей границы интервала.

Значение по умолчанию — 1000.

Примечание. Для различных apiKey используются отдельные БД и для них могут быть установлены независимые ограничения числа событий. Данный параметр влияет на ограничение только для соответствующего apiKey. Чтобы изменить максимально допустимое число событий для других apiKey, используйте YMMReporterConfiguration.maxReportsInDatabaseCount.

location

(nonatomic, strong, nullable) CLLocation *location

Устанавливает собственную информацию о местоположении устройства.

locationTracking

(nonatomic, assign) BOOL locationTracking

Включает/отключает отправку информации о местоположении устройства.

По умолчанию отправка включена.

logs

(nonatomic, assign) BOOL logs

Включает/отключает логирование работы библиотеки.

По умолчанию логирование выключено.

preloadInfo

(nonatomic, copy) YMMYandexMetricaPreloadInfo *preloadInfo

Устанавливает объект класса YMMYandexMetricaPreloadInfo для отслеживания предустановленных приложений.

Подробнее в разделе Трекинг предустановленных приложений.

revenueAutoTrackingEnabled

(nonatomic, assign) BOOL revenueAutoTrackingEnabled

Включает/выключает автоматический сбор информации об In-App покупках.

По умолчанию опция включена.

Возможные значения:
  • YES — режим автоматического сбора и отправки информации об In-App покупках включен.
  • NO — режим автоматического сбора и отправки информации об In-App покупках выключен.

sessionsAutoTracking

(nonatomic, assign) BOOL sessionsAutoTracking

Включает/отключает автоматическое отслеживание жизненного цикла приложений.

По умолчанию опция включена.

Если опция выключена, необходимо вручную настроить контроль продолжительности сессии с использованием методов +pauseSession: и +resumeSession:. Подробнее в разделе Отслеживание сессий вручную.

Для отслеживания сессий AppMetrica использует UIApplicationDidBecomeActiveNotification и UIApplicationWillResignActiveNotification. Максимальная длительность сессии — 24 часа. Чтобы продлить сессию после 24 часов, необходимо вызвать метод +resumeSession: вручную.

sessionTimeout

(nonatomic, assign) NSUInteger sessionTimeout

Задает длительность тайм-аута сессии в секундах.

Значение по умолчанию — 10 (минимально допустимое значение).

Подробнее о сессиях в разделе Отслеживание активности пользователей.

statisticsSending

(nonatomic, assign) BOOL statisticsSending

Включает/отключает отправку статистики на сервер AppMetrica.

Примечание. Отключение отправки статистики также отключит отправку данных со всех репортеров, которые были инициализированы с другим apiKey.

userProfileID

(nonatomic, copy, nullable) NSString *userProfileID

Задает идентификатор пользовательского профиля (ProfileID) при активации.

Внимание. Максимальная длина строки ProfileID — 200 символов.