com.yandex.metrica

Class YandexMetricaConfig

java.lang.Object

com.yandex.metrica.YandexMetricaConfig

public class YandexMetricaConfig
extends java.lang.Object

Класс содержит расширенную стартовую конфигурацию библиотеки. Параметры расширенной конфигурации применяются с момента инициализации библиотеки. Расширенная конфигурация необходима, если вы хотите отслеживать предустановленные приложения.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`YandexMetricaConfig.Builder` Конструктор создает объект класса `YandexMetricaConfig`.

Field Summary

Fields
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

Constructors
Modifier	Constructor and Description
`protected`	`YandexMetricaConfig(YandexMetricaConfig.Builder builder)`
`protected`	`YandexMetricaConfig(YandexMetricaConfig source)`

Method Summary

All Methods
Static Methods
Instance Methods
Concrete Methods
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()`

Methods inherited from class java.lang.Object

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

Field Detail

apiKey

@NonNull
public final java.lang.String apiKey

API key приложения.

See Also:: newConfigBuilder(String)

appVersion

@Nullable
public final java.lang.String appVersion

Версия приложения.

See Also:: YandexMetricaConfig.Builder.withAppVersion(String)

sessionTimeout

@Nullable
public final java.lang.Integer sessionTimeout

Длительность тайм-аута сессии в секундах. Значение по умолчанию — 10 (минимально допустимое значение).

See Also:: YandexMetricaConfig.Builder.withSessionTimeout(int)

crashReporting

@Nullable
public final java.lang.Boolean crashReporting

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

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

See Also:: YandexMetricaConfig.Builder.withCrashReporting(boolean)

nativeCrashReporting

@Nullable
public final java.lang.Boolean nativeCrashReporting

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

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

See Also:: YandexMetricaConfig.Builder.withNativeCrashReporting(boolean)

location

@Nullable
public final android.location.Location location

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

See Also:: YandexMetricaConfig.Builder.withLocation(Location)

locationTracking

@Nullable
public final java.lang.Boolean locationTracking

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

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

See Also:: YandexMetricaConfig.Builder.withLocationTracking(boolean)

logs

@Nullable
public final java.lang.Boolean logs

Признак включения логирования работы библиотеки.

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

See Also:: YandexMetricaConfig.Builder.withLogs()

preloadInfo

@Nullable
public final PreloadInfo preloadInfo

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

See Also:: YandexMetricaConfig.Builder.withPreloadInfo(PreloadInfo)

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

Максимальное число событий, которое может храниться в базе данных на телефоне до отправки в AppMetrica. Если событий будет больше, старые записи начнут удаляться. Значение по умолчанию — 1000. Возможные значения: от 100 до 10000. Если указано значения вне этого диапазона, будет задано значение, максимально близкое к возможному.

See Also:: YandexMetricaConfig.Builder.withMaxReportsInDatabaseCount(int)

errorEnvironment

@Nullable
public final java.util.Map<java.lang.String,java.lang.String> errorEnvironment

Окружение ошибки приложения в виде пары «ключ-значение». Окружение отображается в отчете о крэшах и ошибках. ПРИМЕЧАНИЕ: 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 символов.
Если новая пара превышает общий размер, она будет проигнорирована.

See Also:: YandexMetricaConfig.Builder.withErrorEnvironmentValue(String, String)

userProfileID

@Nullable
public final java.lang.String userProfileID

Идентификатор профиля пользователя. Может содержать до 200 символов.

See Also:: YandexMetricaConfig.Builder.withUserProfileID(String)

revenueAutoTrackingEnabled

@Nullable
public final java.lang.Boolean revenueAutoTrackingEnabled

Признак включения автотрекинга. Значение по умолчанию YandexMetricaDefaultValues.DEFAULT_REVENUE_AUTO_TRACKING_ENABLED.

See Also:: YandexMetricaConfig.Builder.withRevenueAutoTrackingEnabled(boolean)

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)

See Also:: YandexMetricaConfig.Builder.withAppOpenTrackingEnabled(boolean)

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