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

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

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

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

Также вы можете использовать справочник методов в виде Javadoc. JAR-файл справочника доступен в maven-репозитории.

Таблица 1. Методы класса com.yandex.metrica.YandexMetrica

Методы позволяют настроить работу библиотеки.
МетодТипОписание
activate(Context context, String apiKey) voidПозволяет инициализировать библиотеку в приложении
activate(Context context, YandexMetricaConfig config) voidПозволяет инициализировать библиотеку в приложении с расширенной стартовой конфигурацией
getReporter(Context context, String apiKey) IReporterВозвращает объект, позволяющий отправлять события, используя API key, отличный от основного API key
[no-highlight[

API key — это уникальный идентификатор приложения, который выдается в веб-интерфейсе AppMetrica при добавлении приложения.

]no-highlight]
приложения. Используйте методы интерфейса IReporter
onResumeActivity(Activity activity) void

Обеспечивает правильную работу библиотеки. Используйте после инициализации библиотеки в приложении

onPauseActivity(Activity activity) void

Обеспечивает правильную работу библиотеки. Используйте после инициализации библиотеки в приложении

setReportCrashesEnabled(boolean enabled) void

Позволяет отслеживать аварийные остановки приложения.

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

reportUnhandledException(Throwable exception) voidПозволяет вручную отправлять отчеты об аварийных остановках приложения
setReportNativeCrashesEnabled(boolean enabled) void

Позволяет отслеживать нативные аварийные остановки приложения.

По умолчанию отчеты о нативных аварийных остановках приложения отправляются (если SO-файлы библиотеки добавлены в проект). Вы можете отключить отслеживание

reportNativeCrash(String nativeCrash) void

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

setTrackLocationEnabled(boolean enabled) void

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

setLocation(Location location) void

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

reportAppOpen(String deeplink)

voidПозволяет зарегистрировать открытие приложения с помощью deeplink в виде строки
reportAppOpen(Activity activity) voidПозволяет зарегистрировать открытие приложения с помощью deeplink

reportReferralUrl(String referralUrl)

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

reportEvent(String eventName)

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

reportEvent(String eventName, String jsonValue)

voidОтправляет сообщение о событии в формате JSON в виде строки

reportEvent(String eventName, Map<String, Object> attributes)

voidОтправляет сообщение о событии в виде набора атрибутов (Map)

reportError(String message, Throwable error)

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

requestDeferredDeeplinkParameters(DeferredDeeplinkParametersListener listener)

voidПозволяет запросить параметры отложенного deeplink
setSessionTimeout(int sessionTimeoutSeconds) void

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

setCustomAppVersion(String appVersion) voidПо умолчанию версия приложения задается в файле AndroidManifest.xml. Данный метод позволяет указать версию приложения непосредственно из кода приложения
setCollectInstalledApps(boolean collect); voidПозволяет управлять отправкой сведений об установленных на устройстве приложениях. По умолчанию, отправка сведений об установленных приложениях отключена
isCollectInstalledApps() booleanПозволяет определить включена ли отправка сведений об установленных на устройстве приложениях
getLibraryApiLevel() intПозволяет определить уровень API библиотеки
getLibraryVersion() StringПозволяет определить версию библиотеки
enableActivityAutoTracking(final Application application) voidВключает автоматическое отслеживание жизненного цикла приложения. Поддерживает версию Android 4.0 и выше. Является альтернативой методов onResumeActivity(Activity activity) и onPauseActivity(Activity activity). Данный метод необходимо вызвать сразу после инициализации библиотеки AppMetrica до открытия первого экрана приложения
registerReferrerBroadcastReceivers (BroadcastReceiver... anotherReferrerReceivers) voidПозволяет зарегистрировать в AppMetrica произвольное число BroadcastReceiver для трекинга INSTALL_REFERRER от GooglePlay при использовании других систем трекинга
setLogEnabled() voidВключает логирование работы библиотеки AppMetrica

Таблица 2. Методы класса com.yandex.metrica.YandexMetricaConfig

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

МетодТипОписание
static newConfigBuilder(String apiKey) BuilderСоздает объект com.yandex.metrica.YandexMetricaConfig.Builder — конструктор расширенной конфигурации библиотеки AppMetrica
getApiKey() StringВозвращает API key из расширенной конфигурации библиотеки
getAppVersion() StringВозвращает номер версии приложения из расширенной конфигурации библиотеки
getSessionTimeout() intВозвращает тайм-аут сессии из расширенной конфигурации библиотеки
isReportCrashEnabled() booleanПозволяет определить, включено ли в расширенной конфигурации библиотеки отслеживание аварийных остановок приложений
isReportNativeCrashEnabled() booleanПозволяет определить, включено ли в расширенной конфигурации библиотеки отслеживание нативных аварийных остановок приложений
getLocation() LocationВозвращает данные о местоположении устройства в расширенной конфигурации библиотеки
isTrackLocationEnabled() booleanПозволяет определить, включена ли в расширенной конфигурации библиотеки отправка сведений о локации
isLogEnabled() booleanПозволяет определить, включен ли в расширенной конфигурации библиотеки вывод логов библиотекой
isCollectInstalledApps() booleanПозволяет определить, включена ли в расширенной конфигурации библиотеки отправка сведений об установленных приложениях
getPreloadInfo() PreloadInfoВозвращает сведения для отслеживания предустановленных приложений, заданные в расширенной конфигурации библиотеки

Таблица 3. Методы конструктора com.yandex.metrica.YandexMetricaConfig.Builder

Конструктор создает объект класса com.yandex.metrica.YandexMetricaConfig.

МетодТипОписание
setAppVersion(String appVersion) BuilderПозволяет задать в расширенной конфигурации библиотеки версию приложения
setSessionTimeout(int sessionTimeout) BuilderПозволяет задать в расширенной конфигурации библиотеки тайм-аут сессии приложения
setReportCrashesEnabled(boolean reportCrashesEnabled) BuilderПозволяет включить/отключить в расширенной конфигурации библиотеки отправку сведений об аварийных остановках приложения
setReportNativeCrashesEnabled(boolean reportNativeCrashesEnabled) BuilderПозволяет включить/отключить в расширенной конфигурации библиотеки отправку сведений о нативных аварийных остановках приложения
setLogEnabled() BuilderПозволяет включить в расширенной конфигурации библиотеки логирование работы библиотеки
setLocation(Location location) BuilderПозволяет использовать в расширенной конфигурации библиотеки сведения о местоположении пользователя
setTrackLocationEnabled(boolean trackLocationEnabled) BuilderПозволяет разрешить/запретить в расширенной конфигурации библиотеки отправку с отчетами сведений о местоположении пользователя
setCollectInstalledApps(boolean collectInstalledApps) BuilderПозволяет разрешить/запретить в расширенной конфигурации библиотеки отправку сведений об установленных на устройстве пользователя приложениях
setPreloadInfo(PreloadInfo preloadInfo) BuilderПозволяет задать в расширенной конфигурации библиотеки сведения для отслеживания предустановленных приложений
handleFirstActivationAsUpdate(final boolean value) BuilderПозволяет сообщить о том, что первый запуск приложения с AppMetrica SDK следует трактовать как первый запуск обновленной версии приложения, а не как его установку.
Внимание! После активации параметра все последующие установки приложения будут определены AppMetrica как обновления приложения. Данные установки не будут отображены в отчетах как установки а также не будут атрибутированы партнерам.
build() YandexMetricaConfigСоздает объект расширенной конфигурации com.yandex.metrica.YandexMetricaConfig

Таблица 4. Методы класса com.yandex.metrica.PreloadInfo

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

МетодТипОписание
static newBuilder(String trackingId) BuilderСоздает объект com.yandex.metrica.PreloadInfo.Builder — конструктор информации для отслеживания предустановленных приложений
getTrackingId() StringВозвращает tracking ID, который используется для отслеживания предустановленных приложений
getAdditionalParams() Map<String, String>Возвращает таблицу «ключ-значение» дополнительных параметров, которые используются для отслеживания предустановленных приложений

Таблица 5. Методы конструктора com.yandex.metrica.PreloadInfo.Builder

Конструктор создает объект класса com.yandex.metrica.PreloadInfo.

МетодТипОписание
setAdditionalParams(String key, String value) BuilderЗадает дополнительные значения в виде пар «ключ-значения» для отслеживания предустановленных приложений. Метод может быть вызван многократно для задания нескольких пар дополнительных сведений
build() PreloadInfoСоздает объект com.yandex.metrica.PreloadInfo

Таблица 6. Методы интерфейса IReporter

Интерфейс используется для отправки статистики с использованием API key, отличного от API key приложения.
МетодТипОписание
reportUnhandledException(Throwable exception) voidПозволяет вручную отправлять отчеты об аварийных остановках приложения

reportEvent(String eventName)

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

reportEvent(String eventName, String jsonValue)

void

Позволяет отправить сообщение о событии в формате JSON в виде строки. Для отправки сообщения передайте в данный метод краткое имя и описание события.

Доступно 5 уровней вложенности JSON-объекта

reportEvent(String eventName, Map<String, Object> attributes)

voidОтправляет сообщение о событии в виде набора атрибутов (Map). Для отправки сообщения передайте в данный метод краткое имя и описание события

reportError(String message, Throwable error)

voidПозволяет отправлять ваше сообщение об ошибке. Для отправки передайте в метод ваше описание ошибки (message) и класс ошибки (error)
setSessionTimeout(int sessionTimeoutSeconds) void

Позволяет задать длительность тайм-аута сессии (в секундах).

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

Минимально допустимое значение параметра sessionTimeoutSeconds составляет 10 секунд. При задании значения меньше 10, значение автоматически будет соответствовать 10 секундам

onResumeSession() voidСообщает о начале сессии вашего приложения или библиотеки. Подробно
onPauseSession() voidСообщает о возможном завершении сессии вашего приложения или библиотеки. Подробно

Таблица 7. Методы интерфейса DeferredDeeplinkParametersListener

public interface DeferredDeeplinkParametersListener

Интерфейс определяет callback-методы при запросе параметров отложенного deeplink requestDeferredDeeplinkParameters(DeferredDeeplinkParametersListener listener).

МетодТипОписание
onParametersLoaded(Map<String, String> parameters) voidВызывается, когда удается получить параметры отложенного deeplink
onError(Error error, String referrer) voidВызывается, когда при попытке получить параметры отложенного deeplink, происходит ошибка

Таблица 8. Перечисление Error

enum DeferredDeeplinkParametersListener.Error

Содержит возможные значения ошибок для метода DeferredDeeplinkParametersListener.onError(Error error, String referrer).

Поле / МетодТипОписание
NOT_A_FIRST_LAUNCH -Параметры отложенного deeplink не могут быть получены, так как запрос параметров отложенных deeplink возможен только при первом запуске.
PARSE_ERROR -Отложенный deeplink не содержит валидных параметров.
getDescription() StringВозвращает описание ошибки.