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

В коде для обращения к AppMetrica используйте window.appMetrica.

  1. activate
  2. reportEvent
  3. reportError
  4. setLocation
  5. setLocationTracking

activate

Активирует AppMetrica плагин с заданной конфигурацией.

activate(config)

Параметры

Параметр Значение по умолчанию Описание
config*

Тип: Object

Конфигурация плагина

config.apiKey*

Тип: String

Уникальный идентификатор приложения, который выдается в веб-интерфейсе AppMetrica при добавлении приложения

config.handleFirstActivationAsUpdate false

Тип: Boolean

Флаг, сообщающий о том, что первый запуск приложения с AppMetrica SDK следует трактовать как первый запуск обновленной версии приложения, а не как самый первый запуск приложения в его истории
Внимание. Если первый запуск приложения определяется как обновление, то установка не будет отображаться в отчетах как новая установка и не будет атрибутироваться партнерам.
config.locationTracking true

Тип: Boolean

Флаг, включающий или отключающий отправление данных о местоположении устройства

config.sessionTimeout 10

Тип: Number

Длительность тайм-аута сессии (в секундах)

config.crashReporting true

Тип: Boolean

Флаг, включающий или отключающий отслеживание аварийных остановок приложения

config.appVersion null

Тип: String

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

config.logs false

Тип: Boolean

Флаг, включающий и отключающий логирование

config.location null

Тип: Object

Данные о местоположении устройства в определенном формате

config.preloadInfo null

Тип: Object

Данные для отслеживания предустановленных приложений

config.preloadInfo.trackingId*

Тип: Object

Идентификатор трекера

config.preloadInfo.additionalParams

Тип: Object

Дополнительная информация об установленных приложениях. Задается в виде пары «ключ-значение»

* Обязательный параметр/опция.

reportEvent

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

reportEvent(eventName[, params])

Параметры

Параметр Значение по умолчанию Описание
eventName*

Тип: String

Краткое имя или описание события

params

Тип: Object

JavaScript-объект в виде пар «ключ-значения»

* Обязательный параметр/опция.

reportError

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

reportError(errorName[, reason])

Параметры

Параметр Значение по умолчанию Описание
errorName*

Тип: String

Краткое имя или описание ошибки

reason

Тип: String

Описание причины ошибки

* Обязательный параметр/опция.

setLocation

Устанавливает произвольное местоположение устройства.

setLocation(location)

Параметры

Параметр Значение по умолчанию Описание
location*

Тип: Object

Местоположение устройства

location.latitude*

Тип: Number

Широта (в градусах)

location.longitude*

Тип: Number

Долгота (в градусах)

location.altitude

Тип: Number

Высота (в метрах)

location.accuracy

Тип: Number

Точность сети плановых опорных точек (в метрах)

location.verticalAccuracy

Тип: Number

Точность сети высотных опорных точек (в метрах)

location.course

Тип: Number

Направление движения (в градусах)

location.speed

Тип: Number

Скорость движения (в км/ч)

location.timestamp

Тип: Number

Временная отметка местоположения (в Unix-формате)

* Обязательный параметр/опция.

setLocationTracking

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

setLocationTracking(enabled)

Параметры

Параметр Значение по умолчанию Описание
enabled*

Тип: Boolean

Флаг, включающий или отключающий автоматическое определение местоположение

* Обязательный параметр/опция.