Часто задаваемые вопросы по Pushwoosh Android SDK

• Как выглядят Android push-токен и HWID?
• Как получить push-токен моего Android-устройства?
• Какие разрешения необходимы, а какие необязательны?
• Как установить UserID?
• Насколько точно общее количество подписчиков на Android?
• Можно ли использовать HTML-теги в push-уведомлениях, отправляемых на Android?
• Как установить иконку уведомления в Android Lollipop (и более поздних версиях)?
• Использование Pushwoosh SDK с другими сервисами FCM
• Использование Pushwoosh с библиотеками LeakCanary или AppMetrica
• Удаление полученного уведомления с устройства

Push-токены устройств Android различаются по длине (менее 255 символов) и начинаются с APA91b, например:
APA91bFoi3lMMre9G3XzR1LrF4ZT82_15MsMdEICogXSLB8-MrdkRuRQFwNI5u8Dh0cI90ABD3BOKnxkEla8cGdisbDHl5cVIkZah5QUhSAxzx4Roa7b4xy9tvx9iNSYw-eXBYYd8k1XKf8Q_Qq1X9-x-U-Y79vdPq

Также обратите внимание, что токены часто содержат префикс, отделенный двоеточием, перед APA91b, например: eQnyCE6ULAQ:APA91bGrh4ya3b_owo9tshZNVAGhZdGMGb3sA5HbM...

Pushwoosh использует UUID в качестве HWID, то есть случайно сгенерированные строки из 32 буквенно-цифровых символов: 123e4567-e89b-12d3-a456-426655440000

Вы можете получить push-токен вашего Android-устройства в логе консоли. Используйте инструмент logcat в Android Studio.

Откройте monitor.bat в %USERPROFILE%\AppData\Local\Android\sdk\tools\monitor.bat, подключите ваше устройство к ПК и разрешите USB-отладку в настройках Android. Запустите ваше приложение на устройстве. Найдите /registerDevice, затем найдите push-токен для вашего устройства, чтобы использовать его в разделе “Тестовые устройства”.

При установке на устройство Android приложение запросит следующие разрешения, связанные с Pushwoosh SDK:

<!-- FCM connects to Firebase Services. -->
 <uses-permission android:name="android.permission.INTERNET"/>

<!-- Keeps the processor from sleeping when a message is received. -->
 <uses-permission android:name="android.permission.WAKE_LOCK"/>

 <!-- This permission is used to determine whether the device can access the network. -->
 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

<!-- This app has permission to register and receive data message. -->
    <uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />

Наш SDK не запрашивает доступ к изображениям, контактам устройства и т. д.

У вас есть возможность установить идентификатор пользователя (UserID), который может быть ID Facebook, именем пользователя, адресом электронной почты или любым другим уникальным идентификатором пользователя. Это позволяет сопоставлять данные и события на нескольких устройствах, связанных с одним и тем же пользователем. Чтобы установить UserID, вызовите метод setUserId.

Пример

Pushwoosh.getInstance().setUserId("testUser");

Pushwoosh удаляет отписавшиеся Android-устройства из базы данных после получения ответа “NotRegistered” от FCM, который может быть возвращен после второй попытки связаться с конкретным устройством. Это означает, что вам нужно отправить 2 push-уведомления на отписавшееся устройство, чтобы оно было удалено из нашей базы данных.
Вот наиболее распространенный сценарий, описанный в документации FCM:

1. Ваш подписчик удаляет приложение.
2. Pushwoosh отправляет сообщение на сервер FCM.
3. Сервер FCM отправляет сообщение на устройство вашего пользователя.
4. Клиент FCM на устройстве получает сообщение и обнаруживает, что ваше приложение было удалено; детали обнаружения зависят от платформы, на которой работает приложение.
5. Клиент FCM на устройстве информирует сервер FCM о том, что приложение было удалено.
6. Сервер FCM помечает регистрационный ID для удаления.
7. Pushwoosh отправляет еще одно сообщение в FCM.
8. FCM возвращает сообщение NotRegistered.
9. Pushwoosh удаляет push-токен из вашей пользовательской базы.

Может потребоваться некоторое время, чтобы регистрационный ID был полностью удален из FCM. Таким образом, возможно, что сообщение, отправленное на шаге 7, получит в ответ действительный ID сообщения, даже если оно не будет доставлено в клиентское приложение.

Да, в Android вы можете использовать следующие HTML-теги для изменения внешнего вида push-уведомления:

<span style="color: green;"><b><i><span style="text-decoration: underline;">Hello world!
Hello hi hey</span></i></b></span>

Поместите эти HTML-теги в поле ввода Message, а также используйте их в запросе API. Обратите внимание, что некоторые устройства Android могут не обработать эти HTML-теги должным образом, но большинство устройств, которые мы использовали для тестов, отображали форматирование правильно.

В Android Lollipop иконки были изменены и стали отображаться только в белом цвете. Поэтому, если вы укажете targetSdkVersion >= 21 в вашем файле AndroidManifest.xml, Android будет использовать только альфа-канал иконки.
Подробнее о поведении см. в документации Android.

Система игнорирует все каналы, кроме альфа-канала, в иконках действий и в основной иконке уведомления. Предполагается, что эти иконки будут только с альфа-каналом. Система рисует иконки уведомлений белым цветом, а иконки действий — темно-серым. Это находится вне контроля Pushwoosh SDK.

1. Создайте иконку уведомления в соответствии с рекомендациями Android. Согласно документации, система будет игнорировать все цвета.
1.1. Назовите иконку pw_notification.png и поместите ее в папку res/drawable. Pushwoosh SDK будет использовать эту иконку по умолчанию для уведомлений.
1.2. В качестве альтернативы вы можете использовать Remote API и установить значение параметра "android_icon" равным изображению иконки (без расширения файла).

Вы можете использовать Pushwoosh вместе с другими SDK, которые используют FCM для push-сообщений. Для этого вам следует создать сервис-маршрутизатор для распределения событий между сервисами. Сначала добавьте зависимость pushwoosh-firebase вместе с основным модулем Pushwoosh:

implementation 'com.pushwoosh:pushwoosh-firebase:6.0.3'

Создайте класс маршрутизации:

import com.pushwoosh.firebase.PushwooshFcmHelper;

class FirebaseMessagingRouterService : FirebaseMessagingService() {

    override fun onNewToken(token: String?) {
        super.onNewToken(token)
        PushwooshFcmHelper.onTokenRefresh(token)
        sendTokenToAnotherService(token)
    }

    override fun onMessageReceived(remoteMessage: RemoteMessage) {
        if (PushwooshFcmHelper.isPushwooshMessage(remoteMessage)) {
           //this is a Pushwoosh push, SDK will handle it automatically
            PushwooshFcmHelper.onMessageReceived(this, remoteMessage)
        } else {
            //this is not a Pushwoosh push, you should handle it by yourself
            dispatchNonPushwooshMessage(remoteMessage);
        }
    }

    private fun dispatchNonPushwooshMessage(remoteMessage: RemoteMessage) {
       // Implement your push handling logics here
   }
}

import com.pushwoosh.firebase.PushwooshFcmHelper;

public class FirebaseMessagingRouterService extends FirebaseMessagingService {

    @Override
    public void onNewToken(String token) {
        super.onNewToken(token);
        PushwooshFcmHelper.onTokenRefresh(token);
        sendTokenToAnotherService(token);
    }

    @Override
    public void onMessageReceived(RemoteMessage remoteMessage) {
        if (PushwooshFcmHelper.isPushwooshMessage(remoteMessage)) {
            //this is a Pushwoosh push, SDK will handle it automatically
            PushwooshFcmHelper.onMessageReceived(this, remoteMessage);
        } else {
            //this is not a Pushwoosh push, you should handle it by yourself
            dispatchNonPushwooshMessage(remoteMessage);
        }
    }

    private void dispatchNonPushwooshMessage(RemoteMessage remoteMessage) {
        // Implement your push handling logics here
    }
}

Зарегистрируйте маршрутизаторы в вашем AndroidManifest.xml:

<service
    android:name=".FirebaseMessagingRouterService">
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT"/>
    </intent-filter>
</service>

Когда вы интегрируете аналитические инструменты, такие как LeakCanary, AppMetrica или другие, эти библиотеки запускают новый процесс, создавая новый экземпляр приложения. Поскольку вы не можете прослушивать push-уведомления в другом процессе, это приводит к возникновению java.lang.NullPointerException.

Если вы вызываете registerForPushNotifications внутри Application.onCreate(), вам следует проверить, находитесь ли вы в основном процессе приложения. Используйте следующий код для выполнения этой проверки:

List<ActivityManager.RunningAppProcessInfo> runningAppProcesses = ((ActivityManager) getSystemService(Context.ACTIVITY_SERVICE)).getRunningAppProcesses();
if (runningAppProcesses != null && runningAppProcesses.size() != 0) {
    for (ActivityManager.RunningAppProcessInfo runningAppProcessInfo : runningAppProcesses) {
        boolean isCurrentProcess = runningAppProcessInfo.pid == android.os.Process.myPid();
        boolean isMainProcessName = getPackageName().equals(runningAppProcessInfo.processName);
        if (isCurrentProcess && isMainProcessName) {

            Pushwoosh.getInstance().registerForPushNotifications(...);
            break;
        }
    }
}

Если вы хотите удалить неактуальное push-уведомление при выполнении определенного действия в вашем приложении, вы можете использовать следующий подход:

public class MainActivity extends AppCompatActivity {

  List<NotificationCreatedEvent> savedPushes = new ArrayList<>();

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    Pushwoosh.getInstance().registerForPushNotifications();

    PushwooshNotificationSettings.setMultiNotificationMode(true);

    findViewById(R.id.clear_button).setOnClickListener( v -> {
      cancelPushes();
    });

    EventBus.subscribe(NotificationCreatedEvent.class, event -> {
      try {
        if (event.getMessage().getCustomData() == null)
          return;

        //cancel pushes only with a specific flag
        if (new JSONObject(event.getMessage().getCustomData()).getBoolean("cancel")) {
          savedPushes.add(event);
        }
      } catch (JSONException e) {
      }
    });
  }
  private void cancelPushes() {
    NotificationManager manager = (NotificationManager)getSystemService(Context.NOTIFICATION_SERVICE);

    if (manager == null) {
      return;
    }

    for (NotificationCreatedEvent event : savedPushes) {
      manager.cancel(event.getMessageTag(), event.getMessageId());
    }
  }
}

Ваши отзывы помогают нам делать наш продукт лучше, поэтому мы будем рады, если вы сообщите нам о любых проблемах, возникших в процессе интеграции SDK. Если вы столкнетесь с какими-либо трудностями, пожалуйста, не стесняйтесь поделиться своими мыслями с нами через эту форму.