React Native SDK: Руководство по базовой интеграции

В этом разделе содержится информация о том, как интегрировать Pushwoosh React Native SDK в ваше приложение.

Предварительные требования

Для интеграции Pushwoosh React Native SDK в ваше приложение вам потребуется следующее:

Аккаунт Pushwoosh.
Проект Pushwoosh, настроенный в вашем аккаунте.
Для интеграции с iOS:
- Платформа iOS, настроенная для отправки push-уведомлений. Мы рекомендуем использовать конфигурацию на основе токенов аутентификации как самый простой подход.
- Установите Gateway в Sandbox для отправки пушей в симулятор.
Для интеграции с Android:
- Настроенная платформа Android
- project number (также известный как Sender ID), файл google-services.json и package name из вашего проекта Firebase.
- Проект Firebase, подключенный к вашему Android-приложению. При необходимости следуйте руководству по настройке Firebase.
Ваш Pushwoosh Application Code и Pushwoosh Device API Token из Панели управления Pushwoosh для вашего приложения.

Шаги интеграции

1. Добавьте зависимость Pushwoosh React Native SDK

Добавьте зависимость Pushwoosh React Native SDK в ваш проект:

npm install pushwoosh-react-native-plugin --save

2. Инициализация React Native SDK

В корневом компоненте вашего файла index.js:

Импортируйте pushwoosh-react-native-plugin.
Инициализируйте Pushwoosh SDK.
Вызовите register() в вашей логике инициализации для регистрации на получение push-уведомлений.

import Pushwoosh from 'pushwoosh-react-native-plugin';

AppRegistry.registerComponent(appName, () => App);

Pushwoosh.init({
    "pw_appid" : "__YOUR_APP_ID__" ,
    "project_number" : "__YOUR_FCM_SENDER_ID__"
});

Pushwoosh.register();

Где:

__YOUR_APP_ID__ — это код приложения из Панели управления Pushwoosh.
__YOUR_FCM_SENDER_ID__ — это номер проекта Firebase из Firebase Console.

3. Нативная настройка для iOS

3.1 Capabilities

Чтобы включить Push-уведомления в вашем проекте, вам необходимо добавить определенные capabilities.

В разделе Signing & Capabilities добавьте следующие capabilities:

Push Notifications
Background Modes. После добавления этой capability отметьте флажок Remote notifications.

Если вы собираетесь использовать Time Sensitive Notifications (iOS 15+), также добавьте capability Time Sensitive Notifications.

3.2 Info.plist

В вашем Runner/Info.plist установите ключ __PUSHWOOSH_DEVICE_API_TOKEN__ в значение Pushwoosh Device API Token:

<key>Pushwoosh_API_TOKEN</key>
<string>__PUSHWOOSH_DEVICE_API_TOKEN__</string>

3.3 Отслеживание доставки сообщений

Вы должны добавить таргет Notification Service Extension в ваш проект. Это необходимо для точного отслеживания доставки и таких функций, как Rich Media на iOS.

Следуйте шагам из нативного руководства, чтобы добавить таргет расширения и необходимый код Pushwoosh в него.

3.4 Установка зависимостей для проекта iOS React Native

Чтобы установить зависимости для проекта iOS React Native, перейдите в папку ios в терминале и выполните:

pod install --repo-update

4. Нативная настройка для Android

4.1 Установка зависимостей

Убедитесь, что необходимые зависимости и плагины добавлены в ваши Gradle-скрипты:

Добавьте плагин Google Services Gradle в зависимости вашего build.gradle на уровне проекта:

buildscript {
  dependencies {
    classpath 'com.google.gms:google-services:4.3.15'
  }
}

Примените плагин в вашем файле build.gradle на уровне приложения:

apply plugin: 'com.google.gms.google-services'

4.2 Добавьте конфигурационный файл Firebase

Поместите файл google-services.json в папку android/app в каталоге вашего проекта.

4.3 Добавьте метаданные Pushwoosh

В вашем main/AndroidManifest.xml добавьте Pushwoosh Device API Token внутри тега <application>:

<meta-data android:name="com.pushwoosh.apitoken" android:value="__YOUR_DEVICE_API_TOKEN__" />

Важно: Убедитесь, что токен имеет доступ к нужному приложению в вашей Панели управления Pushwoosh. Узнать больше

5. Запустите проект

Соберите и запустите проект.
Перейдите в Панель управления Pushwoosh и отправьте push-уведомление.
Вы должны увидеть уведомление в приложении.

Расширенная интеграция

На этом этапе вы уже интегрировали SDK и можете отправлять и получать push-уведомления. Теперь давайте рассмотрим основную функциональность.

Слушатели событий push-уведомлений

В Pushwoosh SDK есть два слушателя событий, предназначенных для обработки push-уведомлений:

событие pushReceived срабатывает, когда получено push-уведомление
событие pushOpened срабатывает, когда пользователь открывает уведомление

Вам следует настроить эти слушатели событий сразу после инициализации SDK при запуске приложения:

import {DeviceEventEmitter} from 'react-native'
import Pushwoosh from 'pushwoosh-react-native-plugin';

class PushwooshNotificationHandler {
  setupPushListeners() {

    DeviceEventEmitter.addListener('pushReceived', (e) => {
      console.warn("Push received: " + JSON.stringify(e));
    });

    DeviceEventEmitter.addListener('pushOpened', (e) => {
      console.warn("Push accepted: " + JSON.stringify(e));
    });

  }
}

Конфигурация пользователя

Сосредоточившись на поведении и предпочтениях отдельных пользователей, вы можете предоставлять персонализированный контент, что приведет к повышению удовлетворенности и лояльности пользователей.

import Pushwoosh from 'pushwoosh-react-native-plugin';

class Registration {
  afterUserLogin(user: User) {

    // Set user ID
    Pushwoosh.setUserId(user.getId());

    // Set user email
    Pushwoosh.setEmails(user.getEmailList());

    // Set user SMS number
    Pushwoosh.registerSMSNumber(user.getPhoneNumber());

    // Set user WhatsApp number
    Pushwoosh.registerWhatsappNumber(user.getWhatsAppNumber());

    // Setting additional user information as tags for Pushwoosh
    Pushwoosh.setTags({
      "age": user.getAge(),
      "name": user.getName(),
      "last_login": user.getLastLoginDate()
    });
  }
}

Теги — это пары «ключ-значение», присваиваемые пользователям или устройствам, которые позволяют сегментировать аудиторию на основе таких атрибутов, как предпочтения или поведение, что делает возможным таргетированный обмен сообщениями.

import Pushwoosh from 'pushwoosh-react-native-plugin';

class UpdateUser {
  afterUserUpdateProfile(user: User) {

    // Set list of favorite categories
    Pushwoosh.setTags({
      "favorite_categories": user.getFavoriteCategoriesList()
    });

    // Set payment information
    Pushwoosh.setTags({
      "is_subscribed": user.isSubscribed(),
      "payment_status": user.getPaymentStatus(),
      "billing_address": user.getBillingAddress()
    });
  }
}

События

События — это определенные действия пользователя или происшествия в приложении, которые можно отслеживать для анализа поведения и запуска соответствующих сообщений или действий.

import Pushwoosh from 'pushwoosh-react-native-plugin';

class Registration {

  // Track login event
  afterUserLogin(user: User) {
    Pushwoosh.postEvent("login", {
      "name": user.getName(),
      "last_login": user.getLastLoginDate()
    });
  }

  // Track purchase event
  afterUserPurchase(product: Product) {
    Pushwoosh.postEvent("purchase", {
      "product_id": product.getId(),
      "product_name": product.getName(),
      "price": product.getPrice(),
      "quantity": product.getQuantity()
    });
  }
}

Устранение неполадок

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