Интерфейс IReporter

com.yandex.metrica

public interface IReporter

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

Методы

voidpauseSession()

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

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).

voidreportRevenue(@NonNull Revenue revenue)

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

voidreportUnhandledException(@NonNull Throwable exception)

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

voidreportUserProfile(@NonNull UserProfile profile)

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

voidresumeSession()

Возобновляет сессию.

voidsendEventsBuffer()

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

voidsetStatisticsSending(boolean enabled)

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

voidsetUserProfileID(@Nullable String profileID)

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

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

pauseSession

void pauseSession()

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

Подробнее в разделе Отслеживание активности пользователей.

reportError

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

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

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

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

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

reportEvent

void reportEvent(@NonNull String eventName)

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

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

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

reportEvent

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

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

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

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

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

reportEvent

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

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

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

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

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

reportRevenue

void reportRevenue(@NonNull Revenue revenue)

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

Параметры:
revenue

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

reportUnhandledException

void reportUnhandledException(@NonNull Throwable exception)

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

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

reportUserProfile

void reportUserProfile(@NonNull UserProfile profile)

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

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

resumeSession

void resumeSession()

Возобновляет сессию.

Подробнее в разделе Отслеживание активности пользователей.

sendEventsBuffer

void sendEventsBuffer()

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

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

Внимание. Частое использование метода может привести к повышению энергопотребления и расходу исходящего интернет трафика.

setStatisticsSending

void setStatisticsSending(boolean enabled)

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

Подробнее об использовании метода в разделе Отключение и включение отправки статистики.

Примечание. Отключение отправки статистики для репортера не влияет на отправку данных с главного API key. Но отключение отправки данных для главного API key прекращает отправку статистики со всех репортеров.
Параметры:
enabled

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

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

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

setUserProfileID

void setUserProfileID(@Nullable String profileID)

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

Параметры:
userProfileID

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