Интеграция SDK

SDK под Android предоставляется в виде библиотеки в формате AAR. Библиотека доступна в Maven-репозитории.

Ниже описаны этапы подключения и инициализации AppMetrica SDK:

Шаг 1. Добавьте библиотеку в проект

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

dependencies {
    // AppMetrica SDK.
    implementation("io.appmetrica.analytics:analytics:7.2.2")
}
dependencies {
    // AppMetrica SDK.
    implementation 'io.appmetrica.analytics:analytics:7.2.2'
}

Шаг 2. Инициализируйте библиотеку

Внимание

В библиотеке AppMetrica есть особенности, которые необходимо учитывать при инициализации. Подробнее в разделе Особенности библиотеки AppMetrica.

Инициализируйте библиотеку в приложении. Для этого объявите производный класс от базового класса Application и переопределите метод onCreate() следующим образом:

class YourApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        // Creating an extended library configuration.
        val config = AppMetricaConfig.newConfigBuilder(API_KEY).build()
        // Initializing the AppMetrica SDK.
        AppMetrica.activate(this, config)
    }
}
public class YourApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        // Creating an extended library configuration.
        AppMetricaConfig config = AppMetricaConfig.newConfigBuilder(API_KEY).build();
        // Initializing the AppMetrica SDK.
        AppMetrica.activate(this, config);
    }
}
Что такое API key?

API key — уникальный идентификатор приложения, который выдается в веб-интерфейсе AppMetrica при добавлении приложения. Он находится в разделе Настройки.

Опционально

При использовании Firebase Performance Monitoring в Firebase версии 31.0.0+ необходимо активировать FirebaseApp для всех процессов, в том числе, процесса AppMetrica SDK. В Application#onCreate() необходимо вызвать FirebaseApp.initializeApp(this) строго до активации AppMetrica SDK. В противном случае SDK AppMetrica не будет активирован.

Пример:

class YourApplication : Application() {
    override fun onCreate() {
        super.onCreate()

        // Init FirebaseApp for all processes
        FirebaseApp.initializeApp(this)

        // Then activate AppMetrica SDK
        val config = AppMetricaConfig.newConfigBuilder(API_KEY).build()
        AppMetrica.activate(this, config)
    }
}
public class YourApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();

        // Init FirebaseApp for all processes
        FirebaseApp.initializeApp(this);

        // Then activate AppMetrica SDK
        AppMetricaConfig config = AppMetricaConfig.newConfigBuilder(API_KEY).build();
        AppMetrica.activate(this, config);
    }
}

Шаг 3. (Опционально) Настройте определение местоположения

Определение местоположения позволяет оценить географическое распределение пользователей. По умолчанию AppMetrica определяет местоположение устройства по IP-адресу с точностью до страны.

Чтобы определять местоположение с точностью до города, в файле AndroidManifest.xml перед элементом application добавьте элемент uses-permission:

<manifest>
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
    <application>...</application>
</manifest>

ACCESS_COARSE_LOCATION позволяет отслеживать местоположение устройства. Подробнее в документации Android.

Шаг 4. (Опционально) Настройте отправку событий, атрибутов профиля и Revenue

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

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

Примечание

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

Чтобы отслеживать покупки в приложении, настройте отправку Revenue. Подробнее в разделе In-App покупки.

Шаг 5. Протестируйте работу библиотеки

Внимание

Перед проверкой работы библиотеки убедитесь, что SDK инициализирована с соблюдением рекомендаций.

Перед началом тестирования желательно настроить передачу данных на дополнительный API key или добавить приложение с новым API key. Это поможет отделить тестовые данные от основной статистики.

Чтобы проверить работу библиотеки:

  1. Запустите приложение с AppMetrica SDK и используйте его некоторое время.
  2. Убедитесь, что устройство подключено к интернету.
  3. В интерфейсе AppMetrica убедитесь, что:
    • В отчете Аудитория появился новый пользователь.
    • В отчете ВовлечённостьСессии увеличилось число сессий.
    • В отчете События и Профили появились отправленные события и атрибуты профиля.

Возможные проблемы и их решение

Узнайте больше

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

Написать в службу поддержки