com.yandex.metrica

Class YandexMetricaConfig.Builder

  1. Constructor Summary
  2. Method Summary
  3. Methods inherited from class java.lang.Object
  4. Constructor Detail
    1. Builder
  5. Method Detail
    1. withAppVersion
    2. withSessionTimeout
    3. withCrashReporting
    4. withNativeCrashReporting
    5. withLogs
    6. withLocation
    7. withLocationTracking
    8. withPreloadInfo
    9. handleFirstActivationAsUpdate
    10. withStatisticsSending
    11. withMaxReportsInDatabaseCount
    12. withErrorEnvironmentValue
    13. withUserProfileID
    14. withRevenueAutoTrackingEnabled
    15. withSessionsAutoTrackingEnabled
    16. withAppOpenTrackingEnabled
    17. build
java.lang.Object
com.yandex.metrica.YandexMetricaConfig.Builder
Enclosing class:
YandexMetricaConfig

public static class YandexMetricaConfig.Builder
extends java.lang.Object
Конструктор создает объект класса YandexMetricaConfig.

Constructor Summary

Constructors
ModifierConstructor and Description
protected Builder(java.lang.String apiKey) 

Method Summary

All Methods
Instance Methods
Concrete Methods
Modifier and TypeMethod and Description
YandexMetricaConfigbuild()
Создает объект класса YandexMetricaConfig
YandexMetricaConfig.BuilderhandleFirstActivationAsUpdate(boolean value)
Определяет первый запуск приложения как обновление.
YandexMetricaConfig.BuilderwithAppOpenTrackingEnabled(boolean enabled)
Включает/выключает автоматический сбор и отправку информации о запуске приложения через deeplink.
YandexMetricaConfig.BuilderwithAppVersion(java.lang.String appVersion)
Задает версию приложения.
YandexMetricaConfig.BuilderwithCrashReporting(boolean enabled)
Включает/отключает сбор и отправку информации об аварийных остановках приложения.
YandexMetricaConfig.BuilderwithErrorEnvironmentValue(java.lang.String key, java.lang.String value)
Задает окружение ошибки приложения в виде пары «ключ-значение».
YandexMetricaConfig.BuilderwithLocation(android.location.Location location)
Устанавливает собственную информацию о местоположении устройства.
YandexMetricaConfig.BuilderwithLocationTracking(boolean enabled)
Включает/отключает отправку информации о местоположении устройства.
YandexMetricaConfig.BuilderwithLogs()
Включает логирование работы библиотеки..
YandexMetricaConfig.BuilderwithMaxReportsInDatabaseCount(int value)
Задает максимальное число событий, которое может храниться в базе данных на телефоне до отправки в AppMetrica.
YandexMetricaConfig.BuilderwithNativeCrashReporting(boolean enabled)
Включает/отключает отправку информации о нативных аварийных остановках приложения.
YandexMetricaConfig.BuilderwithPreloadInfo(PreloadInfo preloadInfo)
Устанавливает объект класса preload info для отслеживания предустановленных приложений.
YandexMetricaConfig.BuilderwithRevenueAutoTrackingEnabled(boolean enabled)
Включает/выключает автоматический сбор информации об In-App покупках.
YandexMetricaConfig.BuilderwithSessionsAutoTrackingEnabled(boolean enabled)
Включает/отключает автоматический сбор и отправку информации о сессиях пользователя приложения.
YandexMetricaConfig.BuilderwithSessionTimeout(int sessionTimeout)
Задает длительность тайм-аута сессии в секундах.
YandexMetricaConfig.BuilderwithStatisticsSending(boolean value)
Включает/отключает отправку статистики на сервер AppMetrica.
YandexMetricaConfig.BuilderwithUserProfileID(java.lang.String userProfileID)
Устанавливает ID для пользовательского профиля.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

protected Builder(@NonNull
                  java.lang.String apiKey)

Method Detail

withAppVersion

@NonNull
public YandexMetricaConfig.Builder withAppVersion(@Nullable
                                                           java.lang.String appVersion)
Задает версию приложения. По умолчанию версия приложения задается в поле android:versionName AndroidManifest.xml.

ПРИМЕР: 1.0

Parameters:
appVersion - Версия приложения.
Returns:
Объект YandexMetricaConfig.Builder.
Throws:
java.lang.IllegalArgumentException - Если appVersion null или пустое.
See Also:
PackageInfo.versionName

withSessionTimeout

@NonNull
public YandexMetricaConfig.Builder withSessionTimeout(int sessionTimeout)
Задает длительность тайм-аута сессии в секундах. По умолчанию сессия заверашается, если приложение неактивно в течение YandexMetricaDefaultValues.DEFAULT_SESSION_TIMEOUT_SECONDS. Чтобы изменить это значение, передайте нужное значение в секундах в методе builder.withSessionTimeout(int sessionTimeoutSeconds) Минимальное допустимое значение параметра sessionTimeoutSeconds - 10 секунд. Если указано значение меньше 10, оно будет автоматически заменено на 10.

В AppMetrica под длительностью сессии подразумевается следующее.

ПРИМЕР: Пусть продолжительность сессии составляет 2 минуты. Тогда, если началось взаимодействие с вашим приложением после 2 минут бездействия, будет создана новая сессия, в противном случае сеанс будет продолжен.
Parameters:
sessionTimeout - Длительность тайм-аута сессии в секундах. Значение по умолчанию — 10 (минимально допустимое значение).
Returns:
Объект YandexMetricaConfig.Builder.

withCrashReporting

@NonNull
public YandexMetricaConfig.Builder withCrashReporting(boolean enabled)
Включает/отключает сбор и отправку информации об аварийных остановках приложения.

ПРИМЕЧАНИЕ: Значение по умолчанию YandexMetricaDefaultValues.DEFAULT_REPORTS_CRASHES_ENABLED.

Parameters:
enabled - Признак отправки информации об аварийных остановках приложения.

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

Returns:
Объект YandexMetricaConfig.Builder.
See Also:
(boolean)

withNativeCrashReporting

@NonNull
public YandexMetricaConfig.Builder withNativeCrashReporting(boolean enabled)
Включает/отключает отправку информации о нативных аварийных остановках приложения.

ПРИМЕЧАНИЕ: Значение по умолчанию YandexMetricaDefaultValues.DEFAULT_REPORTS_NATIVE_CRASHES_ENABLED

Parameters:
enabled - Признак отправки информации о нативных аварийных остановках приложения.

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

Если отправка информации о нативных аварийных остановках выключена, можно отпралять эти данные с помощью метода YandexMetrica.reportNativeCrash(String).
Returns:
Объект YandexMetricaConfig.Builder.
See Also:
withCrashReporting(boolean)

withLogs

@NonNull
public YandexMetricaConfig.Builder withLogs()
Включает логирование работы библиотеки..
Returns:
Объект YandexMetricaConfig.Builder.

withLocation

@NonNull
public YandexMetricaConfig.Builder withLocation(@Nullable
                                                         android.location.Location location)
Устанавливает собственную информацию о местоположении устройства. Если местоположение задано с помощью этого метода, оно будет использовано вместо автоматически определенного местоположения.

ПРИМЕЧАНИЕ: Разрешения: Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION повышают точность автоматического определения местоположения.

Parameters:
location - Информация о местоположении устройства. Используется в отчетах AppMetrica.
Returns:
Объект YandexMetricaConfig.Builder.
See Also:
withLocationTracking(boolean), YandexMetrica.setLocation(Location), YandexMetrica.setLocationTracking(boolean)

withLocationTracking

@NonNull
public YandexMetricaConfig.Builder withLocationTracking(boolean enabled)
Включает/отключает отправку информации о местоположении устройства.

ПРИМЕЧАНИЕ: Значение по умолчанию YandexMetricaDefaultValues.DEFAULT_REPORT_LOCATION_ENABLED.

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

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

Returns:
Объект YandexMetricaConfig.Builder.
See Also:
withLocation(Location), YandexMetrica.setLocationTracking(boolean), YandexMetrica.setLocation(Location)

withPreloadInfo

@NonNull
public YandexMetricaConfig.Builder withPreloadInfo(@Nullable
                                                            PreloadInfo preloadInfo)
Устанавливает объект класса preload info для отслеживания предустановленных приложений.
Parameters:
preloadInfo - Объект класс PreloadInfo
Returns:
объект YandexMetricaConfig.Builder.

handleFirstActivationAsUpdate

@NonNull
public YandexMetricaConfig.Builder handleFirstActivationAsUpdate(boolean value)
Определяет первый запуск приложения как обновление. ПРИМЕЧАНИЕ: Если первый запуск приложения определяется как обновление, то установка не будет отображаться в отчетах как новая установка и не будет атрибутироваться партнерам.
Parameters:
value - Признак, определяющий тип первого запуска приложения как обновление.

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

Returns:
Объект YandexMetricaConfig.Builder.

withStatisticsSending

@NonNull
public YandexMetricaConfig.Builder withStatisticsSending(boolean value)
Включает/отключает отправку статистики на сервер AppMetrica.

ПРИМЕЧАНИЕ: Отключение отправки статистики также отключит отправку данных со всех репортеров, которые были инициализированы с другим apiKey.

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

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

Returns:
Объект YandexMetricaConfig.Builder.

withMaxReportsInDatabaseCount

@NonNull
public YandexMetricaConfig.Builder withMaxReportsInDatabaseCount(int value)
Задает максимальное число событий, которое может храниться в базе данных на телефоне до отправки в AppMetrica. Если событий будет больше, старые записи начнут удаляться.

ПРИМЕЧАНИЕ: Значение по умолчанию YandexMetricaDefaultValues.DEFAULT_MAX_REPORTS_IN_DATABASE_COUNT

Parameters:
value - Максимальное число событий, которое может храниться в базе данных на телефоне до отправки в AppMetrica. Если событий будет больше, старые записи начнут удаляться. Возможные значения: [YandexMetricaDefaultValues.DEFAULT_MAX_REPORTS_COUNT_LOWER_BOUND; YandexMetricaDefaultValues.DEFAULT_MAX_REPORTS_COUNT_UPPER_BOUND]. Иначе будет задано максимально близкое возможное значение.
Returns:
Объект YandexMetricaConfig.Builder.

withErrorEnvironmentValue

@NonNull
public YandexMetricaConfig.Builder withErrorEnvironmentValue(@NonNull
                                                                      java.lang.String key,
                                                                      @Nullable
                                                                      java.lang.String value)
Задает окружение ошибки приложения в виде пары «ключ-значение». Окружение отображается в отчете о крэшах и ошибках.

Чтобы удалить пару с ключом "key", вызовите: YandexMetrica.putErrorEnvironmentValue("key", null);

ПРИМЕЧАНИЕ: Error Environment отправляется с крэшами и ошибками, которые отправляются с помощью метода YandexMetrica.reportError(String message, Throwable error). Он не применяется к нативным крэшам.

На окружение ошибок есть следующие ограничения:
Максимальная длина ключа — 50 символов. Если длина превышена, ключ обрезается до 50 символов.
Максимальная длина значения — 4000 символов. Если длина превышена, значение обрезается до 4000 символов.
Максимум допустимо 30 пар окружения вида {key, value}. Если попытаться добавить 31-ю пару, она проигнорируется.
Общий размер (sum {len(key) + len(value)} for (key, value) in error_environment) — 4500 символов. Если новая пара превышает общий размер, она будет проигнорирована.

Parameters:
key - Ключ. Максимальная длина ключа — 50 символов. Если длина превышена, ключ обрезается до 50 символов.
value - Значение. Чтобы удалить пару, передайте значение null. Максимальная длина значения — 4000 символов. Если длина превышена, значение обрезается до 4000 символов.
Returns:
Объект YandexMetricaConfig.Builder.

withUserProfileID

@NonNull
public YandexMetricaConfig.Builder withUserProfileID(@Nullable
                                                              java.lang.String userProfileID)
Устанавливает ID для пользовательского профиля. Если отправка ProfileId не настроена, предопределенные атрибуты не отображаются в веб-интерфейсе. ПРИМЕЧАНИЕ: Строка может содержать до 200 символов.
Parameters:
userProfileID - Идентификатор пользовательского профиля.
Returns:
Объект YandexMetricaConfig.Builder.
See Also:
YandexMetrica.setUserProfileID(String)

withRevenueAutoTrackingEnabled

@NonNull
public YandexMetricaConfig.Builder withRevenueAutoTrackingEnabled(boolean enabled)
Включает/выключает автоматический сбор информации об In-App покупках. Значение по умолчанию YandexMetricaDefaultValues.DEFAULT_REVENUE_AUTO_TRACKING_ENABLED.
Parameters:
enabled - Признак автоматического сбора и отправки информации об In-App покупках. true — режим автоматического сбора и отправки информации об In-App покупках включен, false — режим автоматического сбора и отправки информации об In-App покупках выключен.
Returns:
объект YandexMetricaConfig.Builder.

withSessionsAutoTrackingEnabled

@NonNull
public YandexMetricaConfig.Builder withSessionsAutoTrackingEnabled(boolean enabled)
Включает/отключает автоматический сбор и отправку информации о сессиях пользователя приложения.
Parameters:
enabled - true - автотрекинг активен, иначе false.
Returns:
объект YandexMetricaConfig.Builder.
See Also:
Значение по умолчанию {@link YandexMetricaDefaultValues#DEFAULT_SESSIONS_AUTO_TRACKING_ENABLED}.

withAppOpenTrackingEnabled

@NonNull
public YandexMetricaConfig.Builder withAppOpenTrackingEnabled(boolean enabled)
Включает/выключает автоматический сбор и отправку информации о запуске приложения через deeplink. Значение по умолчанию YandexMetricaDefaultValues.DEFAULT_APP_OPEN_TRACKING_ENABLED.
Parameters:
enabled - true - автотрекинг активен, иначе false.
Returns:
объект YandexMetricaConfig.Builder.
See Also:
Установите этот флаг вместо того, чтобы передавать deeplinks вручную из {@link android.app.Activity#onCreate(android.os.Bundle)} через {@link com.yandex.metrica.YandexMetrica#reportAppOpen(android.app.Activity)} NOTE: Автоматическое отслеживание будет фиксировать только те deeplink, которые привели к запуску приложения. Для отслеживания deeplink внутри запущенного приложения вызовите {@link YandexMetrica#reportAppOpen(android.content.Intent)} из {@link android.app.Activity#onNewIntent(android.content.Intent)}

build

@NonNull
public YandexMetricaConfig build()
Создает объект класса YandexMetricaConfig
Returns:
Объект YandexMetricaConfig.