Руководство по переходу на ветку 3.x.x

Внимание.

Это архивная версия документации. Актуальная документация по всем платформам находится здесь.

Руководство содержит примеры, демонстрирующие различия между версиями SDK версий 2.80 и 3.0.0. В разделе рассматриваются только те методы, в которых нарушена обратная совместимость.

Добавлено

Активация репортеров

Вызывается до первого обращения к репортеру. Если обращение к репортеру уже было, активация не изменит параметры. Пример:

YandexMetrica.activateReporter(this, ReporterConfig.newConfigBuilder(API_KEY)
              .withSessionTimeout(100)
              .build());
Скопировано

Профили

Добавлены следующие классы для работы с пользовательскими профилями:

В класс YandexMetrica добавлены следующие методы по работе с профилями:

В интерфейс IReporter добавлены следующие методы по работе с профилями:

Revenue

Добавлены следующие классы для трекинга выручки:

В класс YandexMetrica добавлен следующий метод:

reportRevenue(Revenue revenue).

В интерфейс IReporter добавлен следующий метод:

reportRevenue(Revenue revenue).

Переименовано

Версия 2.80 Версия 3.0.0

Класс `YandexMetrica`.
Версия 2.80	Версия 3.0.0
`onResumeActivity(Activity activity)`	`// Resumes a session. resumeSession(Activity activity)`
`onPauseActivity(Activity activity)`	`// Pauses the session. pauseSession(Activity activity)`
`setTrackLocationEnabled(boolean enabled)`	`// Enables device location sending. setLocationTracking(boolean enabled)`

onResumeActivity(Activity activity)

// Resumes a session.
resumeSession(Activity activity)

onPauseActivity(Activity activity)

// Pauses the session.
pauseSession(Activity activity)

setTrackLocationEnabled(boolean enabled)

// Enables device location sending.
setLocationTracking(boolean enabled)

Версия 2.80 Версия 3.0.0

Класс `YandexMetrica`.
Версия 2.80	Версия 3.0.0
`onResumeActivity(Activity activity)`	`// Resumes a session. resumeSession(Activity activity)`
`onPauseActivity(Activity activity)`	`// Pauses the session. pauseSession(Activity activity)`
`setTrackLocationEnabled(boolean enabled)`	`// Enables device location sending. setLocationTracking(boolean enabled)`

onResumeActivity(Activity activity)

// Resumes a session.
resumeSession(Activity activity)

onPauseActivity(Activity activity)

// Pauses the session.
pauseSession(Activity activity)

setTrackLocationEnabled(boolean enabled)

// Enables device location sending.
setLocationTracking(boolean enabled)

Класс `YandexMetricaConfig`.
Версия 2.80	Версия 3.0.0
`getApiKey()`	`// API key of the application. public final String apiKey`
`getAppVersion()`	`// App Version. public final String appVersion`
`getSessionTimeout()`	`// Session timeout. public final Integer sessionTimeout`
`isReportCrashEnabled()`	`// Application crashes reporting. public final Boolean crashReporting`
`isReportNativeCrashEnabled()`	`// Application native crashes reporting. public final Boolean nativeCrashReporting`
`getLocation()`	`// Location data set by user. public final Location location`
`isTrackLocationEnabled()`	`// Sending device location. public final Boolean locationTracking`
`isCollectInstalledApps()`	`// Sending data about installed apps on the device. public final Boolean installedAppCollecting`
`isLogEnabled`	`// Library logs output. public final Boolean logs`
`getPreloadInfo()`	`// Сведения для отслеживания предустановленных приложений. public final PreloadInfo preloadInfo`
`handleFirstActivationAsUpdate()`	`// The first app launch with the AppMetrica SDK should be treated // as the first launch of the updated app version, and not as an install. public final Boolean firstActivationAsUpdate;`

Класс `YandexMetricaConfig`.
Версия 2.80	Версия 3.0.0
`getApiKey()`	`// API key of the application. public final String apiKey`
`getAppVersion()`	`// App Version. public final String appVersion`
`getSessionTimeout()`	`// Session timeout. public final Integer sessionTimeout`
`isReportCrashEnabled()`	`// Application crashes reporting. public final Boolean crashReporting`
`isReportNativeCrashEnabled()`	`// Application native crashes reporting. public final Boolean nativeCrashReporting`
`getLocation()`	`// Location data set by user. public final Location location`
`isTrackLocationEnabled()`	`// Sending device location. public final Boolean locationTracking`
`isCollectInstalledApps()`	`// Sending data about installed apps on the device. public final Boolean installedAppCollecting`
`isLogEnabled`	`// Library logs output. public final Boolean logs`
`getPreloadInfo()`	`// Сведения для отслеживания предустановленных приложений. public final PreloadInfo preloadInfo`
`handleFirstActivationAsUpdate()`	`// The first app launch with the AppMetrica SDK should be treated // as the first launch of the updated app version, and not as an install. public final Boolean firstActivationAsUpdate;`

Класс `YandexMetricaConfig.Builder`.
Версия 2.80	Версия 3.0.0
`setAppVersion()`	`// Sets the app version. withAppVersion()`
`setSessionTimeout()`	`// Sets the session timeout. withSessionTimeout()`
`setReportCrashEnabled()`	`// Enables application crashes reporting. withCrashReporting()`
`setReportNativeCrashesEnabled()`	`// Enables application native crashes reporting. withNativeCrashReporting()`
`setLocation()`	`// Sets the device location. withLocation()`
`setTrackLocationEnabled()`	`// Enables device location sending. withLocationTracking()`
`setCollectInstalledApps()`	`// Enables sending information about pre-installed apps. withInstalledAppCollecting()`
`setLogEnabled`	`// Enables library logging. withLogs()`
`setPreloadInfo()`	`// Sets the data for tracking pre-installed apps. withPreloadInfo()`

Класс `YandexMetricaConfig.Builder`.
Версия 2.80	Версия 3.0.0
`setAppVersion()`	`// Sets the app version. withAppVersion()`
`setSessionTimeout()`	`// Sets the session timeout. withSessionTimeout()`
`setReportCrashEnabled()`	`// Enables application crashes reporting. withCrashReporting()`
`setReportNativeCrashesEnabled()`	`// Enables application native crashes reporting. withNativeCrashReporting()`
`setLocation()`	`// Sets the device location. withLocation()`
`setTrackLocationEnabled()`	`// Enables device location sending. withLocationTracking()`
`setCollectInstalledApps()`	`// Enables sending information about pre-installed apps. withInstalledAppCollecting()`
`setLogEnabled`	`// Enables library logging. withLogs()`
`setPreloadInfo()`	`// Sets the data for tracking pre-installed apps. withPreloadInfo()`

Удалено


Версия 2.80	Версия 3.0.0
Активация библиотеки с API-ключом. `YandexMetrica.activate(getApplicationContext(), API_KEY);`	`YandexMetricaConfig.Builder configBuilder = YandexMetricaConfig.newConfigBuilder(API_KEY); YandexMetrica.activate(getApplicationContext(), сonfigBuilder.build());` Активировать библиотеку можно только через расширенную конфигурацию `YandexMetricaConfig`.
Установка продолжительности сессии. `YandexMetrica.setSessionTimeout(30);`	Настроить таймаут сессии можно только через расширенную конфигурацию `YandexMetricaConfig`.
Включение сбора аварийных остановок приложения. `YandexMetrica.setReportCrashesEnabled(true); YandexMetrica.setReportNativeCrashesEnabled(true);`	Включить сбор крэшей (аварийных остановок приложения) можно только через расширенную конфигурацию `YandexMetricaConfig`.
Установка версии приложения `YandexMetrica.setCustomAppVersion("1.0.5");`	Установить пользовательскую версию приложения можно только через расширенную конфигурацию `YandexMetricaConfig`.
Включение логирования `YandexMetrica.setLogEnabled();`	Включить логирование можно только через расширенную конфигурацию `YandexMetricaConfig`.
Включение отправки сведений об установленных на устройстве приложениях. `YandexMetrica.setCollectInstalledApps(boolean collect); YandexMetrica.isCollectInstalledApps();`	Включить отправку сведений об установленных на устройстве приложениях можно только через расширенную конфигурацию `YandexMetricaConfig`.
Установка параметров окружения событий. `YandexMetrica.setEnvironmentValue(String key, String value);`	Удален.


Версия 2.80	Версия 3.0.0
Активация библиотеки с API-ключом. `YandexMetrica.activate(getApplicationContext(), API_KEY);`	`YandexMetricaConfig.Builder configBuilder = YandexMetricaConfig.newConfigBuilder(API_KEY); YandexMetrica.activate(getApplicationContext(), сonfigBuilder.build());` Активировать библиотеку можно только через расширенную конфигурацию `YandexMetricaConfig`.
Установка продолжительности сессии. `YandexMetrica.setSessionTimeout(30);`	Настроить таймаут сессии можно только через расширенную конфигурацию `YandexMetricaConfig`.
Включение сбора аварийных остановок приложения. `YandexMetrica.setReportCrashesEnabled(true); YandexMetrica.setReportNativeCrashesEnabled(true);`	Включить сбор крэшей (аварийных остановок приложения) можно только через расширенную конфигурацию `YandexMetricaConfig`.
Установка версии приложения `YandexMetrica.setCustomAppVersion("1.0.5");`	Установить пользовательскую версию приложения можно только через расширенную конфигурацию `YandexMetricaConfig`.
Включение логирования `YandexMetrica.setLogEnabled();`	Включить логирование можно только через расширенную конфигурацию `YandexMetricaConfig`.
Включение отправки сведений об установленных на устройстве приложениях. `YandexMetrica.setCollectInstalledApps(boolean collect); YandexMetrica.isCollectInstalledApps();`	Включить отправку сведений об установленных на устройстве приложениях можно только через расширенную конфигурацию `YandexMetricaConfig`.
Установка параметров окружения событий. `YandexMetrica.setEnvironmentValue(String key, String value);`	Удален.

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