Класс YMMYandexMetrica

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

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

activateWithConfiguration(_:)

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

activateReporterWithConfiguration(_:)

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

handleOpenURL(_:)

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

libraryVersion()

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

reporterForApiKey(_:)

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

reportError(_:exception:onFailure:)

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

reportEvent(_:onFailure:)

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

reportEvent(_:params:onFailure:)

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

reportReferralUrl(_:)

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

reportRevenue(_:onFailure:)

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

reportUserProfile(_:onFailure:)

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

requestAppMetricaDeviceIDWithCompletionQueue(_:block:)

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

sendEventsBuffer()

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

setLocation(_:)

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

setLocationTracking(_:)

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

setStatisticsSending(_:)

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

setUserProfileID(_:)

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

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

activateWithConfiguration(_:)

class func activateWithConfiguration(_ configuration: YMMYandexMetricaConfiguration)

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

Параметры:
configuration

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

activateReporterWithConfiguration(_:)

class func activateReporterWithConfiguration(_ configuration: YMMReporterConfiguration)

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

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

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

Параметры:
configuration

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

handleOpenURL(_:)

class func handleOpenURL(_ url: NSURL) -> Bool

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

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

Параметры:
url

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

Возвращает:

  • true, если deeplink предназначался непосредственно AppMetrica.
  • false, если deeplink не предназначался непосредственно AppMetrica.

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

libraryVersion()

open class func libraryVersion() -> String

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

Возвращает:

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

reporterForApiKey(_:)

class func reporterForApiKey(_ apiKey: String) -> YMMYandexMetricaReporting?

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

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

Параметры:
apiKey

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

Возвращает:

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

reportError(_:exception:onFailure:)

class func reportError(_ message: String, exception: NSException?, onFailure: ((NSError) -> Void)?)

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

Параметры:
message

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

exception

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

onFailure

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

reportEvent(_:onFailure:)

class func reportEvent(_ message: String, onFailure: ((NSError) -> Void)?)

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

Параметры:
message

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

onFailure

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

reportEvent(_:params:onFailure:)

class func reportEvent(_ message: String, parameters params: [NSObject : AnyObject]?, onFailure: ((NSError) -> Void)?)

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

Параметры:
message

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

params

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

onFailure

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

reportReferralUrl(_:)

class func reportReferralUrl(_ url: NSURL)

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

Параметры:
url

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

reportRevenue(_:onFailure:)

class func reportRevenue(_ revenueInfo: YMMRevenueInfo, onFailure: ((NSError) -> Void)?)

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

Параметры:
revenueInfo

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

onFailure

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

reportUserProfile(_:onFailure:)

class func reportUserProfile(_ userProfile: YMMUserProfile, onFailure: ((NSError) -> Void)?)

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

Параметры:
userProfile

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

onFailure

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

requestAppMetricaDeviceIDWithCompletionQueue(_:block:)

class func requestAppMetricaDeviceIDWithCompletionQueue(_ queue: dispatch_queue_t?, completionBlock block: YMMAppMetricaDeviceIDRetrievingBlock)

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

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

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

block

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

sendEventsBuffer()

class func sendEventsBuffer()

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

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

setLocation(_:)

class func setLocation(_ location: CLLocation?)

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

Параметры:
location

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

setLocationTracking(_:)

class func setLocationTracking(_ enabled: Bool)

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

Параметры:
enabled

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

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

setStatisticsSending(_:)

class func setStatisticsSending(_ enabled: Bool)

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

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

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

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

setUserProfileID(_:)

class func setUserProfileID(_ userProfileID: String?)

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

Параметры:
userProfileID

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