Подключение и инициализация AppMetrica Push SDK

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

Начиная с версии 1.0.0, AppMetrica Push SDK использует сервис Firebase Cloud Messaging (FCM) для отправки push-уведомлений.

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

  1. Шаг 1. Подготовьте приложение
  2. Шаг 2. Подключите библиотеку
  3. Шаг 3. Инициализируйте библиотеку
  4. Шаг 4. Настройте Silent Push Notifications
  5. Шаг 5. (Опционально) Включите актуализацию push‑токенов
  6. Отправка дополнительной информации
  7. Отслеживание запуска приложения через push-уведомление
  8. Настройка иконки по умолчанию

Шаг 2. Подключите библиотеку

Начиная с версии 1.4.0 в Push SDK добавлена библиотека OKHttp. Она используется для кэширования изображений, которые показываются в push-уведомлениях. Правила кэширования берутся из HTTP-заголовка cache-control. Если вы не хотите, чтобы изображения кэшировались, подключите библиотеку без кэширования.

  1. В файле build.gradle добавьте зависимости в блоке dependencies:
    dependencies {
        ...
        implementation "com.yandex.android:mobmetricapushlib:1.5.1"
        implementation "com.google.firebase:firebase-messaging:19.0.1"
        implementation "com.google.android.gms:play-services-base:16.1.0"
        implementation "com.android.support:support-compat:28.0.0"
        ...
    }
    Скопировано
    Примечание. Минимальная версия support-compat — 26.0.0.
  2. Инициализируйте Firebase, используя один из способов:

    Использование Google Services Plugin
    1. Загрузите конфигурационный файл google-services.json и разместите его в каталоге модуля проекта (например, app).
    2. Для корректной работы с файлом подключите плагин Google Services в проект, добавив следующие строки в файл build.gradle:

      проекта
      buildscript{
          ...
          dependencies {
              ...
              classpath 'com.google.gms:google-services:4.3.0'
              ...
          }
          ...
      }
      Скопировано
      приложения (модуля)
      // In the end of the file.
      apply plugin: 'com.google.gms.google-services'
      Скопировано
    Без использования плагина

    Внесите изменения в элемент application файла AndroidManifest.xml:

    <meta-data android:name="ymp_firebase_default_app_id" android:value="APP_ID"/>
    <meta-data android:name="ymp_gcm_default_sender_id" android:value="number:SENDER_ID"/>
    
    <!-- If you have a dependency on com.google.firebase:firebase-auth -->
    <meta-data android:name="ymp_firebase_default_api_key" android:value="API_KEY"/>
    Скопировано

    APP_ID — идентификатор приложения в Firebase. Его можно узнать в консоли Firebase: перейдите в Настройки проекта. В разделе Ваши приложения скопируйте значение поля Идентификатор приложения.

    SENDER_ID — уникальный идентификатор отправителя в Firebase. Его можно узнать в консоли Firebase: перейдите во вкладку Настройки проекта → Cloud Messaging и скопируйте значение поля Идентификатор отправителя.

    API_KEY — ключ приложения в Firebase. Его можно найти в поле current_key файла google-services.json. Файл можно скачать из консоли Firebase.