Класс YMMYandexMetrica

Методы класса используются для настройки работы библиотеки.

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

+activateWithConfiguration:

Инициализирует библиотеку в приложении с расширенной стартовой конфигурацией.

+activateReporterWithConfiguration:

Инициализирует репортер с расширенной конфигурацией.

+handleOpenURL:

Обрабатывает URL, который открыл приложение.

+libraryVersion

Возвращает текущую версию библиотеки AppMetrica.

-reporterForApiKey:

Создает репортер для отправки событий на дополнительный API key.

+reportError:exception:onFailure:

Отправляет сообщение об ошибке.

+reportEvent:params:onFailure:

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

+reportEvent:onFailure

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

+reportReferralUrl:

Задает referral URL установки приложения. Метод может быть использован для отслеживания некоторых источников трафика.

+reportRevenue:onFailure:

Отправляет информацию о покупке на сервер AppMetrica.

+reportUserProfile:onFailure:

Отправляет информацию об обновлении пользовательского профиля.

+requestAppMetricaDeviceIDWithCompletionQueue:

Запрашивает уникальный идентификатор AppMetrica (deviceID).

+sendEventsBuffer:

Отправляет сохраненные события из буфера.

+setLocation:

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

+setLocationTracking:

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

+setStatisticsSending:

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

+setUserProfileID:

Устанавливает ID для пользовательского профиля.

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

+activateWithConfiguration:

+ (void)activateWithConfiguration:(YMMYandexMetricaConfiguration *)configuration

Инициализирует библиотеку в приложении с расширенной стартовой конфигурацией.

Параметры:
configuration

Объект класса YMMYandexMetricaConfiguration, который содержит расширенную стартовую конфигурацию библиотеки.

+activateReporterWithConfiguration:

+ (void)activateReporterWithConfiguration:(YMMReporterConfiguration *)configuration

Инициализирует репортер с расширенной конфигурацией.

Конфигурация репортера должна быть инициализирована до первого обращения к репортеру. Иначе конфигурация репортера игнорируется.

Репортер должен быть инициализирован с конфигурацией, которая содержит API key, отличный от API key приложения.

Параметры:
configuration

Объект класса YMMReporterConfiguration, который содержит расширенную конфигурацию репортера.

+handleOpenURL:

+ (BOOL)handleOpenURL:(NSURL *)url

Обрабатывает URL, который открыл приложение.

Используется для регистрации открытия приложения с помощью deeplink

Параметры:
url

URL, который открыл приложение.

Возвращает:

  • YES, если deeplink предназначался AppMetrica.
  • NO, если deeplink не предназначался AppMetrica.

На данный момент такого deeplink нет. Метод всегда возвращает NO.

+libraryVersion:

+ (NSString *)libraryVersion

Возвращает текущую версию библиотеки AppMetrica.

Возвращает:

Версию библиотеки.

-reporterForApiKey:

- (nullable id<YMMYandexMetricaReporting>)reporterForApiKey:(NSString *)apiKey

Создает репортер для отправки событий на дополнительный API key.

Чтобы инициализировать репортер с расширенной конфигурацией, используйте метод activateReporterWithConfiguration:. Конфигурация репортера должна быть инициализирована до первого обращения к репортеру. Иначе, конфигурация репортера игнорируется.

Параметры:
apiKey

API key, отличный от API key приложения.

Возвращает:

Объект, реализующий протокол YMMYandexMetricaReporting для заданного API key приложения.

+reportError:exception:onFailure:

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

Отправляет сообщение об ошибке.

Параметры:
message

Короткое название или описание ошибки.

exception

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

onFailure

Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент.

+reportEvent:onFailure:

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

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

Параметры:
message

Короткое название или описание события.

onFailure

Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент.

+reportEvent:params:onFailure:

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

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

Параметры:
message

Короткое название или описание события.

params

Параметры в виде пар «ключ-значение».

onFailure

Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент.

+reportReferralUrl:

+ (void)reportReferralUrl:(NSURL *)url

Задает referral URL установки приложения. Метод может быть использован для отслеживания некоторых источников трафика.

Параметры:
url

Referral URL установки приложения.

+reportRevenue:onFailure:

+ (void)reportRevenue:(YMMRevenueInfo *)revenueInfo
            onFailure:(nullable void (^)(NSError *error))onFailure

Отправляет информацию о покупке на сервер AppMetrica.

Параметры:
revenueInfo

Объект класса YMMRevenueInfo, который содержит информацию о покупке.

onFailure

Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент.

+reportUserProfile:onFailure:

+ (void)reportUserProfile:(YMMUserProfile *)userProfile
                onFailure:(nullable void (^)(NSError *error))onFailure

Отправляет информацию об обновлении пользовательского профиля.

Параметры:
userProfile

Объект класса YMMUserProfile, который содержит информацию о пользовательском профиле.

onFailure

Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент.

+requestAppMetricaDeviceIDWithCompletionQueue:block:

+ (void)requestAppMetricaDeviceIDWithCompletionQueue:(nullable dispatch_queue_t)queue
                                     completionBlock:(YMMAppMetricaDeviceIDRetrievingBlock)block

Запрашивает уникальный идентификатор AppMetrica (deviceID).

Примечание. В Logs API и Post API deviceID обозначается как appmetrica_device_id.
Параметры:
queue

Очередь, на которой будет вызван callback-блок.

block

Сallback-блок получения appmetrica_device_id. Включает в себя идентификатор appMetricaDeviceID и ошибку error, если не удалось получить идентификатор.

+sendEventsBuffer:

+ (void)sendEventsBuffer

Отправляет сохраненные события из буфера.

AppMetrica SDK не отправляет события сразу после того, как оно произошло. Библиотека хранит данные о событиях в буфере. Метод sendEventsBuffer() отправляет данные из буфера и очищает его. Используйте этот метод для принудительной отправки сохраненных событий после прохождения важных сценариев пользователя.
Внимание. Частое использование метода может привести к повышению энергопотребления и расходу исходящего интернет-трафика.

+setLocation:

+ (void)setLocation:(CLLocation *)location

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

Параметры:
location

Информация о местоположении устройства.

+setLocationTracking:

+ (void)setLocationTracking:(BOOL)enabled

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

Параметры:
enabled

Признак отправки информации о местоположении устройства. Значение по умолчанию — YES.

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

+setStatisticsSending:

+ (void)setStatisticsSending:(BOOL)enabled

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

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

Признак отправки статистики.

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

Возможные значения:

  • YES — отправка статистики включена.
  • NO — отправка статистики выключена.

+setUserProfileID:

+ (void)setUserProfileID:(nullable NSString *)userProfileID

Устанавливает ID для пользовательского профиля.

Параметры:
userProfileID

Идентификатор пользовательского профиля.