Подключение пушей Андроид

1 February 2022

На странице Настройки > Каналы выберите существующий или создайте новый канал, в котором хотите разместить приложение. Вы можете объединить в одном канале приложения, пользователям которых хотите отправлять пуши в рамках одной рассылки.

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

• Проект приложения Андроид с minSdk не ранее 21 (Андроид 5) и targetSdk не позже 34 (Андроид 14)
• Параметры Sender ID и Server Key из Firebase
• Файл google-services.json из Firebase
• Устройство с Андроид 5.0 и новее или эмулятор с сервисами Google Play
• Актуальная версия Android Studio

Описанные далее процессы предполагают, что вы завершили шаги, описанные в статье Создание канала пуш-уведомлений.

Шаг 1. Введите данные из Firebase

  1. Зарегистрируйте приложение в консоли Firebase.
  2. Получите параметры Sender ID и Server Key из Firebase.
  3. На странице Настройки > Каналы > Настройка приложения Android в edna Pulse введите имя приложения, а также параметры Sender ID и Server Key для своего приложения в поля Firebase Sender ID и Firebase API Key соответственно.



    Если требуется отправлять пуши также через облако Huawei, далее следуйте инструкции по подключению пуш-облака Huawei.
  4. Нажмите Сохранить и продолжить.

Шаг 2. Добавьте зависимости в файл build.gradle

  1. Добавьте зависимости в файл build.gradle проекта — укажите адрес репозитория edna и добавьте в список зависимостей сервисы Google:
  buildscript {  
      //...
    dependencies {
        //...
        classpath "com.google.gms:google-services:4.3.10"
    }
    //...
  allprojects {
    repositories {
       //...
        maven { url 'https://maven-pub.edna.ru/repository/maven-releases'}
    }
}
  1. В файл build.gradle приложения подключите плагин и добавьте библиотеку edna в список зависимостей:
      apply plugin: 'com.google.gms.google-services'

      dependencies {
         //...
         implementation platform("com.edna.android:push-x-bom:2.3.2")
      }
  1. Укажите в манифесте приложения следующую строку с ключом доступа к пуш-сервису edna
<meta-data android:name="com.pushserver.android.appId" 
android:value="ключ доступа к пуш-сервису edna с шага 2 настроек приложения" />
  1. Добавьте файл google-services.json в корень директории app вашего приложения в Android Studio.

  2. Библиотека edna по умолчанию инициализируется автоматически. Но если в приложении реализован Configuration.Provider, используйте ручную инициализацию библиотеки.

Шаг 3. Добавьте код обработки нажатий на уведомление

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

Библиотека edna обработает информацию о переходе пользователя и направит Intent в стартовое Activity приложения. Обработайте полученную от библиотеки edna информацию в методах onCreate и onNewIntent приложения.

Библиотека edna передаст в Intent строку действия, указанную вами в рассылке. Пример кода для обработки перехода клиента по уведомлению:

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        //...
        intent?.extras?.getParcelable<PushAction>(PUSH_ACTION_KEY)?.let {
        // Hавигация клиента с учётом переданной строки, где PUSH_ACTION_KEY = "action"
            redirectUser(it.action)
        }
        //...
    }

    override fun onNewIntent(intent: Intent?) {
        super.onNewIntent(intent)
        //...
        intent?.extras?.getParcelable<PushAction>(PUSH_ACTION_KEY)?.let {
        // Hавигация клиента с учётом переданной строки, где PUSH_ACTION_KEY = "action"
            redirectUser(it.action)
        }
        //...
    }
}
public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        PushAction extraAction = getIntent().getExtras().getParcelable(PUSH_ACTION_KEY);
	// Hавигация клиента с учётом переданной строки, где PUSH_ACTION_KEY = "action"
        redirectUser(extraAction);
    }

    @Override
    protected void onNewIntent(Intent intent) {
        super.onNewIntent(intent);
        PushAction extraAction = getIntent().getExtras().getParcelable(PUSH_ACTION_KEY);
	// Hавигация клиента с учётом переданной строки, где PUSH_ACTION_KEY = "action"
        redirectUser(extraAction);
    }
}

Шаг 4. Поддержите регистрацию устройств пользователей в сервисе edna

  1. Выберите тип регистрации устройства на платформе.

    Устройство пользователя появится в сервисе edna после регистрации. Сейчас доступен только автоматический способ регистрации. Скоро будет добавлен ручной способ.
    • При автоматической регистрации библиотека edna самостоятельно регистрирует устройство в сервисе edna. Этот способ проще, не требует от вас управлять регистрацией, но не рекомендуется для отправки конфиденциальных данных.
    • После появления ручного способа ваш бэкенд сможет самостоятельно регистрировать устройство в сервисе edna через специальный метод API.
  2. Для регистрации пользователя в сервисе вызовите метод login библиотеки, укажите идентификатор пользователя и тип идентификатора SubscriberIdType.

Следует вызывать метод только после успешной авторизации пользователя в вашем приложении:

PushX.login("79001002030", SubscriberIdType.PHONE_NUMBER)

PushX.login("79001002030", SubscriberIdType.PHONE_NUMBER.INSTANCE)

Доступны следующие виды SubscriberIdType:

  • Номер телефона (PhoneNumber)
  • Адрес электронной почты (Email)
  • Идентификаторы Facebook*, Телеграм, Гугл, Эпл, Яндекс (FacebookId*, TelegramId, GoogleId, AppleId, YandexId)
  • Внутренние идентификаторы пользователя (ExtUserId, CookieId)
  • UTM-метка (UTM)
  1. В момент деавторизации пользователя в приложении, вызовите метод logout библиотеки, чтобы отключить устройство пользователя в сервисе edna:
PushX.logout()

* Деятельность сети запрещена на территории РФ

Шаг 5. Скомпилируйте и запустите приложение

  1. Подключите к интернету устройство для проверки интеграции.
  2. Скомпилируйте и запустите приложение.
  3. На странице Настройки > Каналы > Настройка приложения Android в edna Pulse после запуска приложения нажмите Далее — откроется экран ожидания регистрации устройства (Шаг 6 на экране).

Шаг 6. Проверьте подключение устройства и протестируйте получение пуша

На данном шаге сервис edna поможет проверить корректность интеграции. Если всё сделано правильно, вы увидите название своего тестового устройства и кнопку отправки тестового пуша. Если вы запустили приложение на нескольких устройствах, на данном шаге сможете увидеть только последнее подключенное.

  1. Нажмите Протестировать пуши.

  2. Проверьте, что пуш приходит и отображается на тестовом устройстве.
  3. Если пуш пришёл и отображается как следует, подтвердите доставку пуша, нажав Да.

Готово! Теперь можете настроить каскад и запустить рассылку.

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

In this article
In this article