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

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

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

activate

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

activate(config)

Параметры

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

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

]no-highlight]

Тип: Object

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

config.apiKey*
[no-highlight[

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

]no-highlight]

Тип: String

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

config.handleFirstActivationAsUpdateEnabled false

Тип: Boolean

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

Примечание. После активации параметра все последующие установки приложения будут определены AppMetrica как обновления приложения. Данные установки не будут отображены в отчетах как установки а также не будут атрибутированы партнерам.

config.trackLocationEnabled true

Тип: Boolean

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

config.sessionTimeout 10

Тип: Number

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

config.reportCrashesEnabled true

Тип: Boolean

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

config.appVersion null

Тип: String

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

config.loggingEnabled false

Тип: Boolean

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

config.location null

Тип: Object

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

config.preloadInfo null

Тип: Object

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

config.preloadInfo.trackingId*
[no-highlight[

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

]no-highlight]

Тип: Object

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

config.preloadInfo.additionalInfo

Тип: Object

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

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

reportEvent

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

reportEvent(eventName[, params])

Параметры

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

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

]no-highlight]

Тип: String

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

params

Тип: Object

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

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

reportError

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

reportError(errorName[, reason])

Параметры

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

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

]no-highlight]

Тип: String

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

reason

Тип: String

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

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

setCustomAppVersion

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

setCustomAppVersion(appVersion)

Параметры

ПараметрЗначение по умолчаниюОписание
appVersion*
[no-highlight[

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

]no-highlight]

Тип: String

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

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

setLocation

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

setLocation(location)

Параметры

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

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

]no-highlight]

Тип: Object

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

location.latitude*
[no-highlight[

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

]no-highlight]

Тип: Number

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

location.longitude*
[no-highlight[

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

]no-highlight]

Тип: Number

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

location.altitude

Тип: Number

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

location.accuracy

Тип: Number

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

location.verticalAccuracy

Тип: Number

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

location.course

Тип: Number

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

location.speed

Тип: Number

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

location.timestamp

Тип: Number

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

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

setTrackLocationEnabled

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

setTrackLocationEnabled(enabled)

Параметры

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

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

]no-highlight]

Тип: Boolean

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

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

setSessionTimeout

Устанавливает таймаут сессии, по истечению которого приложение считается неактивным. Минимальное значение — 10 секунд. Все значения заданные меньше минимального автоматически сбросят значение таймаута на 10.

setSessionTimeout(sessionTimeoutSeconds)

Параметры

ПараметрЗначение по умолчаниюОписание
sessionTimeoutSeconds*
[no-highlight[

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

]no-highlight]
10

Тип: Number

Таймаут сессии, по истечению которого приложение считается неактивным (в секундах)

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

setReportCrashesEnabled

Включает или отключает отслеживание аварийных остановок приложения (крэшей).

setReportCrashesEnabled(enabled)

Параметры

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

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

]no-highlight]
true

Тип: Boolean

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

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

setLoggingEnabled

Включение возможности логирования.

setLoggingEnabled()

setCollectInstalledAppsEnabled

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

Внимание! Работает только для устройств на системе Android.
setCollectInstalledAppsEnabled(enabled)

Параметры

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

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

]no-highlight]
false

Тип: Boolean

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

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