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

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

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

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

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

Методы позволяют настроить работу библиотеки.
МетодОписание
open class func activate(withApiKey apiKey: String) Позволяет запустить процесс сбора статистики
open class func activate(with configuration: YMMYandexMetricaConfiguration) Позволяет запустить процесс сбора статистики с расширенной конфигурацией
open class func setCustomAppVersion(_ appVersion: String) Позволяет указать версию приложения
open class func setLoggingEnabled(_ isEnabled: Bool) Позволяет включить и отключить логирование
open class func setReportCrashesEnabled(_ enabled: Bool) Позволяет отслеживать аварийные остановки приложения
open class func setTrackLocationEnabled(_ enabled: Bool)

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

open class func setLocation(_ location: CLLocation?)

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

open class func reportEvent(_ message: String, onFailure: (@escaping (Error?) -> Swift.Void)? = nil)

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

open class func reportEvent(_ message: String, parameters params: [AnyHashable : Any]?, onFailure: (@escaping (Error?) -> Swift.Void)? = nil)

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

open class func reportError(_ message: String, exception: NSException?, onFailure: (@escaping (Error?) -> Swift.Void)? = nil)

Позволяет отправлять произвольное сообщение об ошибке
open class func setSessionTimeout(_ sessionTimeoutSeconds: UInt) Позволяет задать длительность тайм-аута сессии (в секундах)
open class func handleOpen(_ url: URL) -> Bool Позволяет зарегистрировать открытие приложения с помощью deeplink

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

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

open class func libraryVersion() -> String

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

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

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

МетодОписание
public init?(apiKey: String) Создает объект класса YMMYandexMetricaConfiguration — конструктор расширенной конфигурации библиотеки AppMetrica

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

СвойствоОписание
open var apiKey: String { get } Позволяет получить API key из расширенной конфигурации библиотеки
open var customAppVersion: String? Позволяет указать версию приложения
open var sessionTimeout: UInt Позволяет задать тайм-аут сессии в секундах
open var reportCrashesEnabled: Bool Позволяет отслеживать аварийные остановки приложения
open var trackLocationEnabled: Bool Позволяет разрешить/запретить библиотеке отправлять данные о местоположении устройства в отчетах
open var location: CLLocation? Позволяет передать собственные данные о местоположении устройства
open var loggingEnabled: Bool Позволяет включить/отключить логирование
open var preloadInfo: YMMYandexMetricaPreloadInfo? Позволяет передать данные для отслеживания предустановленных приложений
open var handleFirstActivationAsUpdateEnabled: Bool Позволяет сообщить о том, что первый запуск приложения с AppMetrica SDK следует трактовать как первый запуск обновленной версии приложения, а не как самый первый запуск приложения в его истории
Примечание. После активации параметра все последующие установки приложения будут определены AppMetrica как обновления приложения. Данные установки не будут отображены в отчетах как установки а также не будут атрибутированы партнерам.

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

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

МетодОписание
public init?(trackingIdentifier trackingID: String) Создает объект класса YMMYandexMetricaPreloadInfo
open func setAdditional(_ info: String, forKey key: String) Позволяет задать дополнительные значения в виде пар «ключ-значения» для отслеживания предустановленных приложений. Метод может быть вызван многократно для задания нескольких пар дополнительных сведений