Mindbox
Android SDK

3.1. Отправка push-notifications через Firebase

Результат шага «Отправка push-notifications на Android через Firebase»:

Push-уведомление отправляется из Mindbox и отображается на устройстве. Проверить, что push-уведомления отправляются, можно с помощью этой инструкции.

1. Сделайте интеграцию вашего приложения с Firebase

Из официальной инструкции по добавлению Firebase нужны следующие пункты:

  • зарегистрировать свое приложение в Firebase;
  • скачать и положить по инструкции файл google-services.json;
  • подключить Сервисы Google в свое приложение;
  • добавьте firebase-messaging в build.gradle;
  • передать менеджеру проекта Firebase Server Key.
build.gradle
dependencies { implementation platform('com.google.firebase:firebase-bom:33.7.0') implementation 'com.google.firebase:firebase-analytics-ktx' implementation 'com.google.firebase:firebase-messaging-ktx' ... }

Если в вашем приложении указан targetSdk 33, то для получения уведомлений вам также нужно добавить разрешение (подробнее тут, пример реализации тут)

В файле AndroidManifest.xml:

KotlinCode
<uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>

В файле MainActivity.kt:

KotlinKotlin
private val requestPermissionLauncher = registerForActivityResult(ActivityResultContracts.RequestPermission()) { isGranted -> if (isGranted) { Mindbox.updateNotificationPermissionStatus(this) } } if (ContextCompat.checkSelfPermission( applicationContext, Manifest.permission.POST_NOTIFICATIONS ) != PackageManager.PERMISSION_GRANTED ) { requestPermissionLauncher.launch(Manifest.permission.POST_NOTIFICATIONS) }

2. Реализовать отображение уведомлений

Базовая интеграция

Подходит, если не требуется кастомная логика.

Самостоятельная интеграция

Подходит, если требуется кастомная логика для самостоятельной отрисовки push-уведомлений.

Для выбора поведения при ошибке загрузки картинок или для написания собственной логики используйте метод setMessageHandling

3 Зарегистрируйте сервис обработки push-уведомлений в AndroidManifest.xml

Добавьте в файл AndroidManifest.xml следующие пункты:

XMLCode
<application ...> ... <service android:name=".MindboxFirebaseMessagingService" android:exported="false"> <intent-filter> <action android:name="com.google.firebase.MESSAGING_EVENT"/> </intent-filter> </service> ... </application>

4. Доработайте метод инициализации, чтобы push-уведомления отображались всегда

4.1 Добавьте библиотеку для обработки push-уведомлений

В файл app/build.gradle в блок dependencies (Module: app). Лучше указать фиксированную версию, чтобы контролировать обновление. Актуальную версию вы можете посмотреть на странице библиотеки в Maven Central.

build.gradle
dependencies { ... implementation 'cloud.mindbox:mobile-sdk:{версия}' implementation 'cloud.mindbox:mindbox-firebase' ... }

Начиная с версии 2.15.5 модуль mindbox-firebase добавляет в манифест приложения разрешение AD_ID. Если приложение публикуется в Google Play, проверьте декларации в Play Console — подробнее в разделе Разрешение AD_ID.

4.2 Укажите библиотеку в методе инициализации

В методе Mindbox.init, который должен быть размещен в коллбэке onCreate вашего приложения, нужно указать, что в этой сборке используется MindboxFirebase.

KotlinKotlin
import cloud.mindbox.mobile_sdk.Mindbox import cloud.mindbox.mobile_sdk.MindboxConfiguration import cloud.mindbox.mindbox_firebase.MindboxFirebase class MyApplication : Application() { override fun onCreate() { super.onCreate() // .... // Было // Mindbox.init(applicationContext, configuration, listOf()) // Нужно Mindbox.init(applicationContext, configuration, listOf(MindboxFirebase)) // ... } }

Добавьте в коллбэк onCreate вашего приложения вызов метода Mindbox.initPushServices.

KotlinKotlin
import cloud.mindbox.mobile_sdk.Mindbox import cloud.mindbox.mindbox_firebase.MindboxFirebase class MyApplication : Application() { override fun onCreate() { super.onCreate() // .... Mindbox.initPushServices(applicationContext, listOf(MindboxFirebase)) Mindbox.init(applicationContext, configuration, listOf(MindboxFirebase)) // ... } }

5. Используйте отдельное Firebase-приложение для push-токена (опционально)

Доступно начиная с версии SDK 2.15.3.

Этот шаг нужен, если в приложении используется несколько SDK, которые работают с push-уведомлениями через Firebase. Такие SDK могут перезаписать общий FCM-токен, из-за чего push-уведомления Mindbox перестанут доходить.

Если этой проблемы у вас нет, раздел можно пропустить, все будет работать как раньше.

Как это работает

Mindbox создаст собственный изолированный инстанс Firebase (named-приложение) со своим FCM-токеном. Сторонние SDK на него не влияют, и пуши Mindbox доходят стабильно.

Как включить

  1. Уберите Mindbox.updatePushToken из onNewToken в созданном FirebaseMessagingService.
  2. В файл res/values/strings.xml добавьте ресурс mindbox_firebase_app_name (значение может быть любым):
XMLres/values/strings.xml
<resources> <string name="mindbox_firebase_app_name">mindbox-named</string> </resources>

Этого достаточно: Mindbox сам создаст named-приложение и будет брать токен из него.

  1. Если включен resource shrinking, добавьте его в исключения, чтобы ресурс не вырезали из release-сборки. Создайте или дополните файл res/raw/keep.xml:
XMLres/raw/keep.xml
<resources xmlns:tools="http://schemas.android.com/tools" tools:keep="@string/mindbox_firebase_app_name" />

Обратите внимание

  • onNewToken использовать не нужно — уберите его. Для named-приложения Firebase его не вызывает (только для основного приложения).

  • Токен обновится сам. Если токен сменится, Mindbox передаст новый при следующем открытии или сворачивании/разворачивании приложения. Если нужно передать раньше, сделайте это вручную:

    KotlinCode
    `Mindbox.updatePushToken(context, token, MindboxFirebase)`.

Проверьте результат шага «Отправка push-notifications через Firebase»:

Из Mindbox отправляется мобильное push-уведомление, и оно отображается на устройстве.

Проверить, что push-уведомления отправляются, можно с помощью этой инструкции.

Last modified on