Класс YandexMetrica

com.yandex.mertica

public final class YandexMetrica

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

Методы

voidactivate(@NonNull Context context, @NonNull YandexMetricaConfig config)

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

voidactivateReporter(@NonNull Context context, @NonNull ReporterConfig config)

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

voidenableActivityAutoTracking(@NonNull Application application)

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

intgetLibraryApiLevel()

Возвращает уровень API библиотеки.

StringgetLibraryVersion()

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

IReportergetReporter(@NonNull Context context, @NonNull String apiKey)

Возвращает объект, который реализует интерфейс IReporter для заданного API key.

voidpauseSession(@Nullable Activity activity)

Приостанавливает сессию.

voidregisterReferrerBroadcastReceivers(@NonNull BroadcastReceiver... anotherReferrerReceivers)

Регистрирует BroadcastReciever другой системы трекинга.

voidreportAppOpen(@NonNull String deeplink)

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

voidreportAppOpen(@NonNull Activity activity)

Отправляет сообщение об открытии приложения с помощью deeplink.

voidreportError(@NonNull String message, @Nullable Throwable error)

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

voidreportEvent(@NonNull String eventName)

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

voidreportEvent(@NonNull String eventName, @Nullable String jsonValue)

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

voidreportEvent(@NonNull String eventName, @Nullable Map<String, Object> attributes)

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

voidreportNativeCrash(@NonNull String nativeCrash)

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

voidreportReferralUrl(@NonNull String referralUrl)

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

voidreportRevenue(@NonNull Revenue revenue)

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

voidreportUnhandledException(@NonNull Throwable exception)

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

voidreportUserProfile(@NonNull UserProfile profile)

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

voidrequestAppMetricaDeviceID(@NonNull AppMetricaDeviceIDListener listener)

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

voidrequestDeferredDeeplinkParameters(@NonNull DeferredDeeplinkParametersListener listener)

Запрашивает параметры отложенного deeplink.

voidresumeSession(@Nullable Activity activity)

Возобновляет сессию или создает новую, если тайм-аут сессии истек.

voidsendEventsBuffer()

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

voidsetLocation(@Nullable Location location)

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

voidsetLocationTracking(boolean enabled)

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

voidsetStatisticsSending(@NonNull Context context, boolean enabled)

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

voidsetUserProfileID(@Nullable String userProfileID)

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

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

activate

public static void activate(@NonNull Context context, @NonNull YandexMetricaConfig config)

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

Параметры:
context

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

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

activateReporter

public static void activateReporter(@NonNull Context context, @NonNull ReporterConfig config)

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

Примечание. Активация репортера должна происходить до вызова метода getReporter().
Параметры:
context

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

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

enableActivityAutoTracking

public static void enableActivityAutoTracking(@NonNull Application application)

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

Является альтернативой методов resumeSession(Activity activity) и pauseSession(Activity activity). Данный метод необходимо вызвать сразу после инициализации библиотеки AppMetrica до открытия первого экрана приложения. Поддерживает версию Android 4.0 и выше.

Параметры:
applicationОбъект класса Application.

getLibraryApiLevel

public static int getLibraryApiLevel()

Возвращает уровень API библиотеки.

Возвращает:

Уровень API библиотеки.

getLibraryVersion

public static String getLibraryVersion()

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

Возвращает:

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

getReporter

public static IReporter getReporter(@NonNull Context context, @NonNull String apiKey)

Возвращает объект, который реализует интерфейс IReporter для заданного API key.

Используется для отправки статистики с использованием API key, отличного от API key приложения.

Параметры:
context

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

apiKey

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

Возвращает:

Объект IReporter.

pauseSession

public static void pauseSession(@Nullable Activity activity)

Приостанавливает сессию.

Вызывается в реализации метода onPause() Activity вашего приложения. Используйте после инициализации библиотеки в приложении.

Примечание. Длительность сессии зависит от заданного тайм-аута. Если интервал между приостановкой и возобновлением сессии меньше заданного времени тайм-аута, то текущая сессия будет возобновлена, если больше — будет создана новая.
Параметры:
activityОбъект класса Activity.

registerReferrerBroadcastReceivers

public static void registerReferrerBroadcastReceivers(@NonNull BroadcastReceiver... anotherReferrerReceivers)

Регистрирует BroadcastReciever другой системы трекинга.

Метод используется для трекинга INSTALL_REFERRER от GooglePlay при использовании других систем трекинга.

Параметры:
anotherReferrerReceiversОбъект класса BroadcastReceiver.

reportAppOpen

public static void reportAppOpen(@NonNull String deeplink)

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

Параметры:
deeplinkDeeplink в виде строки.

reportAppOpen

public static void reportAppOpen(@NonNull Activity activity)

Отправляет сообщение об открытии приложения с помощью deeplink.

Параметры:
activityОбъект класса Activity.

reportError

public static void reportError(@NonNull String message, @Nullable Throwable error)

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

Параметры:
messageОписание ошибки.

Не должно быть пустым.

errorКласс ошибки.

reportEvent

public static void reportEvent(@NonNull String eventName)

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

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

Не должно быть пустым.

reportEvent

public static void reportEvent(@NonNull String eventName, @Nullable String jsonValue)

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

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

Не должно быть пустым.

jsonValueВалидная JSON-строка с произвольным содержимым.

reportEvent

public static void reportEvent(@NonNull String eventName, @Nullable Map<String, Object> attributes)

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

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

Не должно быть пустым.

attributesНабор атрибутов (Map).

reportNativeCrash

public static void reportNativeCrash(@NonNull String nativeCrash)

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

Параметры:
nativeCrashСообщение о нативной аварийной остановке.

reportReferralUrl

public static void reportReferralUrl(@NonNull String referralUrl)

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

Параметры:
referralUrl

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

reportRevenue

public static void reportRevenue(@NonNull Revenue revenue)

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

Параметры:
revenue

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

reportUnhandledException

public static void reportUnhandledException(@NonNull Throwable exception)

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

Параметры:
exceptionОбъект класса Throwable.

reportUserProfile

public static void reportUserProfile(@NonNull UserProfile profile)

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

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

requestAppMetricaDeviceID

public static void requestAppMetricaDeviceID(@NonNull AppMetricaDeviceIDListener listener)

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

Уникальный идентификатор deviceID доступен в интерфейсе AppMetricaDeviceIDListener.onLoaded(String deviceID), если не возникает ошибок при получении. Если ошибка возникает, то значение ошибки хранится в интерфейсе AppMetricaDeviceIDListener.onError(Error error, String referrer).

Примечание. В Logs API и Post API deviceID обозначается как appmetrica_device_id.
Параметры:
listenerИнтерфейс для оповещения о получении уникального идентификатора.

requestDeferredDeeplinkParameters

public static void requestDeferredDeeplinkParameters(@NonNull DeferredDeeplinkParametersListener listener)

Запрашивает параметры отложенного deeplink.

Параметры отложенного deeplink доступны в интерфейсе DeferredDeeplinkParametersListener.onParametersLoaded(Map<String, String> parameters), если не возникает ошибок при получении Google Play Install Referrer. Подробнее в разделах Примеры использования методов и Поддержка отложенных deeplinks.

Параметры:
listenerИнтерфейс для оповещения о получении параметров отложенного deeplink.

resumeSession

public static void resumeSession(@Nullable Activity activity)

Возобновляет сессию или создает новую, если тайм-аут сессии истек.

Вызывается в реализации метода onResume()Activity вашего приложения. Используйте после инициализации библиотеки в приложении.

Примечание. Длительность сессии зависит от заданного тайм-аута. Если интервал между приостановкой и возобновлением сессии меньше заданного времени тайм-аута, то текущая сессия будет возобновлена, если больше — будет создана новая.
Параметры:
activityОбъект класса Activity.

sendEventsBuffer

public static void sendEventsBuffer()

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

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

setLocation

public static void setLocation(@Nullable Location location)

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

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

Параметры:
location

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

setLocationTracking

public static void setLocationTracking(boolean enabled)

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

Параметры:
enabled

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

Значение по умолчанию — true.

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

setStatisticsSending

public static void setStatisticsSending(@NonNull Context context, boolean enabled)

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

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

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

enabled

Признак включения отправки статистики.

Значение по умолчанию — true.

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

setUserProfileID

public static void setUserProfileID(@Nullable String userProfileID)

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

Параметры:
userProfileID

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