Class YandexMetricaConfig.Builder
- Constructor Summary
- Method Summary
- Methods inherited from class java.lang.Object
- Constructor Detail
- Method Detail
- withAppVersion
- withSessionTimeout
- withCrashReporting
- withNativeCrashReporting
- withLogs
- withLocation
- withLocationTracking
- withPreloadInfo
- handleFirstActivationAsUpdate
- withStatisticsSending
- withMaxReportsInDatabaseCount
- withErrorEnvironmentValue
- withUserProfileID
- withRevenueAutoTrackingEnabled
- withSessionsAutoTrackingEnabled
- withAppOpenTrackingEnabled
- build
- Enclosing class:
- YandexMetricaConfig
public static class YandexMetricaConfig.Builder
extends java.lang.Object
YandexMetricaConfig
.Constructor Summary
Modifier | Constructor and Description |
---|---|
protected | Builder(java.lang.String apiKey) |
Method Summary
Modifier and Type | Method and Description |
---|---|
YandexMetricaConfig | build()
Создает объект класса
YandexMetricaConfig |
YandexMetricaConfig.Builder | handleFirstActivationAsUpdate(boolean value)
Определяет первый запуск приложения как обновление.
|
YandexMetricaConfig.Builder | withAppOpenTrackingEnabled(boolean enabled)
Включает/выключает автоматический сбор и отправку информации о запуске приложения через deeplink.
|
YandexMetricaConfig.Builder | withAppVersion(java.lang.String appVersion)
Задает версию приложения.
|
YandexMetricaConfig.Builder | withCrashReporting(boolean enabled)
Включает/отключает сбор и отправку информации об аварийных остановках приложения.
|
YandexMetricaConfig.Builder | withErrorEnvironmentValue(java.lang.String key, java.lang.String value)
Задает окружение ошибки приложения в виде пары «ключ-значение».
|
YandexMetricaConfig.Builder | withLocation(android.location.Location location)
Устанавливает собственную информацию о местоположении устройства.
|
YandexMetricaConfig.Builder | withLocationTracking(boolean enabled)
Включает/отключает отправку информации о местоположении устройства.
|
YandexMetricaConfig.Builder | withLogs()
Включает логирование работы библиотеки..
|
YandexMetricaConfig.Builder | withMaxReportsInDatabaseCount(int value)
Задает максимальное число событий, которое может храниться в базе данных на телефоне до отправки в AppMetrica.
|
YandexMetricaConfig.Builder | withNativeCrashReporting(boolean enabled)
Включает/отключает отправку информации о нативных аварийных остановках приложения.
|
YandexMetricaConfig.Builder | withPreloadInfo(PreloadInfo preloadInfo)
Устанавливает объект класса
preload info для отслеживания предустановленных приложений. |
YandexMetricaConfig.Builder | withRevenueAutoTrackingEnabled(boolean enabled)
Включает/выключает автоматический сбор информации об In-App покупках.
|
YandexMetricaConfig.Builder | withSessionsAutoTrackingEnabled(boolean enabled)
Включает/отключает автоматический сбор и отправку информации о сессиях пользователя приложения.
|
YandexMetricaConfig.Builder | withSessionTimeout(int sessionTimeout)
Задает длительность тайм-аута сессии в секундах.
|
YandexMetricaConfig.Builder | withStatisticsSending(boolean value)
Включает/отключает отправку статистики на сервер AppMetrica.
|
YandexMetricaConfig.Builder | withUserProfileID(java.lang.String userProfileID)
Устанавливает ID для пользовательского профиля.
|
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)
ПРИМЕЧАНИЕ: Отключение отправки статистики также отключит отправку данных со всех репортеров, которые были инициализированы с другим apiKey.
- Parameters:
value
- Признак включения отправки статистики.Значение по умолчанию —
true
. Возможные значения:true
— отправка статистики включена.false
— отправка статистики выключена.- Returns:
- Объект
YandexMetricaConfig.Builder
.
withMaxReportsInDatabaseCount
@NonNull public YandexMetricaConfig.Builder withMaxReportsInDatabaseCount(int value)
ПРИМЕЧАНИЕ: Значение по умолчанию 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)
- Parameters:
userProfileID
- Идентификатор пользовательского профиля.- Returns:
- Объект
YandexMetricaConfig.Builder
. - See Also:
YandexMetrica.setUserProfileID(String)
withRevenueAutoTrackingEnabled
@NonNull public YandexMetricaConfig.Builder withRevenueAutoTrackingEnabled(boolean enabled)
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)
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
.