Документация
Интеграция SDK

Справочник методов

AppMetrica является потокобезопасной библиотекой. Поэтому любой из данных методов может быть вызван на произвольном потоке.

Внимание! Не передавайте личную или конфиденциальную информацию о пользователях в пользовательском событии.

Таблица 1. Методы класса YMMYandexMetrica

Методы позволяют настроить работу библиотеки.
МетодОписание
+(void)activateWithApiKey:(NSString *)apiKey; Позволяет запустить процесс сбора статистики
+(void)activateWithConfiguration:(YMMYandexMetricaConfiguration *)configuration; Позволяет инициализировать библиотеку в приложении с расширенной стартовой конфигурацией
+(BOOL)enableTrackingWithURLScheme:(NSURL *)urlScheme; Включает трекинг передаваемой на вход deeplink схемы приложения. Схема должна быть зарегистрирована в CFBundleURLTypes секции Info.plist файла приложения.
+(void)setCustomAppVersion:(NSString *)appVersion; Позволяет указать версию приложения
+(void)setLoggingEnabled:(BOOL)enabled; Позволяет включить и отключить логирование
+(void)setReportCrashesEnabled:(BOOL)enabled; Позволяет отслеживать аварийные остановки приложения
+(void)setTrackLocationEnabled:(BOOL)enabled;

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

+(void)setLocation:(CLLocation *)location;

Устанавливает передавать собственные данные о местоположении устройства

+(void)reportEvent:(NSString *)message onFailure:(void (^)(NSError *error))onFailure;

Отправляет произвольное сообщение о событии.

+(void)reportEvent:(NSString *)message parameters:(NSDictionary *)params onFailure:(void (^)(NSError *error))onFailure;

Отправляет произвольное сообщение о событии и дополнительные параметры

+(void)reportError:(NSString *)message exception:(NSException *)exception onFailure:(void (^)(NSError *error))onFailure;

Отправляет произвольное сообщение об ошибке
+(void)setSessionTimeout:(NSUInteger)sessionTimeoutSeconds; Позволяет задать длительность тайм-аута сессии (в секундах)
+(BOOL)handleOpenURL:(NSURL *)url; Позволяет зарегистрировать открытие приложения с помощью deeplink
-(nullable id<YMMYandexMetricaReporting>)reporterForApiKey:(NSString *)apiKey Создает репортер для отправки событий на дополнительный API key
+ (void)reportReferralUrl:(NSURL *)urlЗадает referral URL установки приложения. Метод может быть использован для отслеживания некоторых источников трафика, например, Facebook.

Методы-геттеры:

МетодОписание

+(NSString *)libraryVersion;

Определяет текущую версию библиотеки AppMetrica

Таблица 2. Методы класса YMMYandexMetricaConfiguration

Класс содержит расширенную стартовую конфигурацию библиотеки. Расширенная конфигурация необходима, если вы хотите отслеживать предустановленные приложения.

МетодОписание
-(instancetype)initWithApiKey:(NSString *)apiKey; Создает объект класса YMMYandexMetricaConfiguration — конструктор расширенной конфигурации библиотеки AppMetrica

Таблица 3. Свойства класса YMMYandexMetricaConfiguration

СвойствоОписание
(nonatomic, copy, readonly) NSString *apiKey;Позволяет получить API key из расширенной конфигурации библиотеки
(nonatomic, copy) NSString *customAppVersion; Позволяет указать версию приложения
(nonatomic, assign) NSUInteger sessionTimeout; Позволяет задать тайм-аут сессии в секундах
(nonatomic, assign) BOOL reportCrashesEnabled; Позволяет отслеживать аварийные остановки приложения
(nonatomic, assign) BOOL trackLocationEnabled; Позволяет разрешить/запретить библиотеке отправлять данные о местоположении устройства в отчетах
(nonatomic, strong) CLLocation *location; Позволяет передать собственные данные о местоположении устройства
(nonatomic, assign) BOOL loggingEnabled; Позволяет включить/отключить логирование
(nonatomic, copy) YMMYandexMetricaPreloadInfo *preloadInfo; Позволяет передать данные для отслеживания предустановленных приложений
(nonatomic, assign) BOOL handleFirstActivationAsUpdateEnabled; Позволяет сообщить о том, что первый запуск приложения с AppMetrica SDK следует трактовать как первый запуск обновленной версии приложения, а не как самый первый запуск приложения в его истории
Примечание. После активации параметра все последующие установки приложения будут определены AppMetrica как обновления приложения. Данные установки не будут отображены в отчетах как установки а также не будут атрибутированы партнерам.

Таблица 4. Методы класса YMMYandexMetricaPreloadInfo

Класс содержит информацию для отслеживания предустановленных приложений.

МетодОписание
-(instancetype)initWithTrackingIdentifier:(NSString *)trackingID; Создает объект класса YMMYandexMetricaPreloadInfo
-(void)setAdditionalInfo:(NSString *)info forKey:(NSString *)key; Позволяет задать дополнительные значения в виде пар «ключ-значения» для отслеживания предустановленных приложений. Метод может быть вызван многократно для задания нескольких пар дополнительных сведений

Таблица 5. Методы протокола YMMYandexMetricaReporting

МетодОписание
-(void)reportEvent:(NSString *)name onFailure:(nullable void (^)(NSError *error))onFailure; Отправляет произвольное сообщение о событии
-(void)reportEvent:(NSString *)name parameters:(nullable NSDictionary *)params onFailure:(nullable void (^)(NSError *error))onFailure; Отправляет произвольное сообщение о событии и дополнительные параметры
-(void)reportError:(NSString *)name exception:(nullable NSException *)exception onFailure:(nullable void (^)(NSError *error))onFailure; Отправляет произвольное сообщение об ошибке
-(void)resumeSession; Сообщает о начале сессиии вашего приложения или библиотеки
-(void)pauseSession; Сообщает о возможном завершении сессии вашего приложения или библиотеки