Class YandexMetricaConfig
public class YandexMetricaConfig
extends java.lang.Object
Nested Class Summary
Modifier and Type | Class and Description |
---|---|
static class | YandexMetricaConfig.Builder
Конструктор создает объект класса
YandexMetricaConfig . |
Field Summary
Modifier and Type | Field and Description |
---|---|
java.lang.String | apiKey
API key приложения.
|
java.lang.Boolean | appOpenTrackingEnabled
Показывает, включено ли автоматическое отслеживание открытия приложения.
|
java.lang.String | appVersion
Версия приложения.
|
java.lang.Boolean | crashReporting
Признак отправки информации об аварийных остановках приложения.
|
java.util.Map<java.lang.String,java.lang.String> | errorEnvironment
Окружение ошибки приложения в виде пары «ключ-значение».
|
java.lang.Boolean | firstActivationAsUpdate
Признак, определяющий тип первого запуска приложения как обновление.
|
android.location.Location | location
Информация о местоположении устройства.
|
java.lang.Boolean | locationTracking
Признак отправки информации о местоположении устройства.
|
java.lang.Boolean | logs
Признак включения логирования работы библиотеки.
|
java.lang.Integer | maxReportsInDatabaseCount
Максимальное число событий, которое может храниться в базе данных на телефоне до отправки в AppMetrica.
|
java.lang.Boolean | nativeCrashReporting
Признак отправки информации о нативных аварийных остановках приложения.
|
PreloadInfo | preloadInfo
Объект класса PreloadInfo.
|
java.lang.Boolean | revenueAutoTrackingEnabled
Признак включения автотрекинга.
|
java.lang.Boolean | sessionsAutoTrackingEnabled
Показывает, включен ли автотрекинг сессий.
|
java.lang.Integer | sessionTimeout
Длительность тайм-аута сессии в секундах.
|
java.lang.Boolean | statisticsSending
Признак включения отправки статистики.
|
java.lang.String | userProfileID
Идентификатор профиля пользователя.
|
Constructor Summary
Modifier | Constructor and Description |
---|---|
protected | YandexMetricaConfig(YandexMetricaConfig.Builder builder) |
protected | YandexMetricaConfig(YandexMetricaConfig source) |
Method Summary
Modifier and Type | Method and Description |
---|---|
static YandexMetricaConfig.Builder | createBuilderFromConfig(YandexMetricaConfig source) |
static YandexMetricaConfig | fromJson(java.lang.String json) |
static YandexMetricaConfig.Builder | newConfigBuilder(java.lang.String apiKey)
Создает объект
YandexMetricaConfig.Builder — конструктор расширенной конфигурации библиотеки AppMetrica. |
java.lang.String | toJson() |
Field Detail
apiKey
@NonNull public final java.lang.String apiKey
- See Also:
newConfigBuilder(String)
appVersion
@Nullable public final java.lang.String appVersion
sessionTimeout
@Nullable public final java.lang.Integer sessionTimeout
crashReporting
@Nullable public final java.lang.Boolean crashReporting
Признак отправки информации об аварийных остановках приложения.
Значение по умолчанию — true
. Возможные значения: true
— отправка информации об аварийных остановках включена. false
— отправка информации об аварийных остановках выключена.
nativeCrashReporting
@Nullable public final java.lang.Boolean nativeCrashReporting
Признак отправки информации о нативных аварийных остановках приложения.
Значение по умолчанию — true
. Возможные значения: true
— отправка информации о нативных аварийных остановках включена. false
— отправка информации о нативных аварийных остановках выключена.
location
@Nullable public final android.location.Location location
locationTracking
@Nullable public final java.lang.Boolean locationTracking
Признак отправки информации о местоположении устройства.
Значение по умолчанию — true
. Возможные значения: true
— отправка информации о местоположении устройства включена. false
— отправка информации о местоположении устройства выключена.
logs
@Nullable public final java.lang.Boolean logs
Признак включения логирования работы библиотеки.
Значение по умолчанию — false
. Возможные значения: true
— логирование работы библиотеки включено. false
— логирование работы библиотеки выключено.
- See Also:
YandexMetricaConfig.Builder.withLogs()
firstActivationAsUpdate
@Nullable public final java.lang.Boolean firstActivationAsUpdate
Признак, определяющий тип первого запуска приложения как обновление.
Значение по умолчанию — false
. Возможные значения: true
— первый запуск определяется как обновление. false
— первый запуск определяется как новая установка.
ПРИМЕЧАНИЕ: Если первый запуск приложения определяется как обновление, то установка не будет отображаться в отчетах как новая установка и не будет атрибутироваться партнерам.
statisticsSending
@Nullable public final java.lang.Boolean statisticsSending
Значение по умолчанию — true
. Возможные значения: true
— отправка статистики включена. false
— отправка статистики выключена.
maxReportsInDatabaseCount
@Nullable public final java.lang.Integer maxReportsInDatabaseCount
errorEnvironment
@Nullable public final java.util.Map<java.lang.String,java.lang.String> errorEnvironment
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 символов.
Если новая пара превышает общий размер, она будет проигнорирована.
userProfileID
@Nullable public final java.lang.String userProfileID
revenueAutoTrackingEnabled
@Nullable public final java.lang.Boolean revenueAutoTrackingEnabled
YandexMetricaDefaultValues.DEFAULT_REVENUE_AUTO_TRACKING_ENABLED
.sessionsAutoTrackingEnabled
@Nullable public final java.lang.Boolean sessionsAutoTrackingEnabled
Показывает, включен ли автотрекинг сессий.
Установка этого флага в значение true эквивалентна вызовуYandexMetrica.enableActivityAutoTracking(android.app.Application)
Значение по умолчанию YandexMetricaDefaultValues.DEFAULT_SESSIONS_AUTO_TRACKING_ENABLED
.appOpenTrackingEnabled
@Nullable public final java.lang.Boolean appOpenTrackingEnabled
YandexMetricaDefaultValues.DEFAULT_APP_OPEN_TRACKING_ENABLED
. Установите для этого флага значение true вместо того, чтобы сообщать о deeplink вручную из Activity.onCreate(android.os.Bundle)
с помощью YandexMetrica.reportAppOpen(android.app.Activity)
NOTE: Автоматическое отслеживание будет фиксировать только те deeplink, которые привели к запуску приложения. Для отслеживания deeplink внутри запущенного приложения вызовите YandexMetrica.reportAppOpen(android.content.Intent)
из Activity.onNewIntent(android.content.Intent)
Constructor Detail
YandexMetricaConfig
protected YandexMetricaConfig(@NonNull YandexMetricaConfig.Builder builder)
YandexMetricaConfig
protected YandexMetricaConfig(@NonNull YandexMetricaConfig source)
Method Detail
newConfigBuilder
@NonNull public static YandexMetricaConfig.Builder newConfigBuilder(@NonNull java.lang.String apiKey)
YandexMetricaConfig.Builder
— конструктор расширенной конфигурации библиотеки AppMetrica.- Parameters:
apiKey
- API_KEY - API key приложения.- Returns:
- Объект класса YandexMetricaConfig.Builder.
- Throws:
java.lang.IllegalArgumentException
- ЕслиapiKey
null, пустое или имеет неподдерживаемый формат.- See Also:
- Документация SDK AppMetrica.
fromJson
public static YandexMetricaConfig fromJson(java.lang.String json)
createBuilderFromConfig
@NonNull public static YandexMetricaConfig.Builder createBuilderFromConfig(@NonNull YandexMetricaConfig source)
toJson
public java.lang.String toJson()