Типы сообщений Firebase Cloud Messaging

С помощью FCM вы можете отправлять в клиентские приложения сообщения двух типов:

  • Уведомления, похожие на сообщения на экране, обрабатываются SDK FCM автоматически.
  • Сообщения с данными, которые обрабатываются клиентским приложением.

Уведомления содержат предопределенный набор ключей, видимых пользователю, и могут содержать необязательную полезную нагрузку данных. Сообщения с данными, напротив, содержат только заданные пользователем пары "ключ-значение". Максимальный размер полезной нагрузки для обоих типов сообщений составляет 4096 байт, за исключением случаев, когда сообщения отправляются из консоли Firebase, в которой действует ограничение на количество символов в 1000.

Использовать сценарий Как отправить
Уведомление SDK FCM показывает сообщение на устройствах конечных пользователей от имени клиентского приложения, когда оно работает в фоновом режиме. Если же приложение запущено и открыто, то его поведение определяется кодом.

  1. В доверенной среде, например Cloud Functions или на сервере приложения, используйте Firebase Admin SDK или HTTP v1 API. Задайте ключ notification. Может содержать необязательную полезную нагрузку. Всегда сворачиваемый.

    Ознакомьтесь с примерами уведомлений и отправьте полезную нагрузку запроса.

  2. Используйте компоновщик уведомлений. Введите текст сообщения, заголовок и т. д. и отправьте его. Добавьте необязательную полезную нагрузку, указав специальные данные.
Сообщение с данными За обработку сообщений с данными отвечает клиентское приложение. Сообщения с данными содержат только специальные пары "ключ-значение" без зарезервированных названий ключей (см. ниже). В доверенной среде, например Cloud Functions или на сервере приложения, используйте Firebase Admin SDK или HTTP v1 API. В запросе на отправку задайте ключ data.

Используйте уведомления, если хотите, чтобы SDK FCM автоматически показывал уведомление, когда приложение работает в фоновом режиме. FCM может отправлять уведомления с необязательной полезной нагрузкой. В таких случаях FCM показывает полезную нагрузку уведомления, а клиентское приложение обрабатывает полезную нагрузку данных.

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

Уведомления

Вы можете отправлять уведомления с помощью консоли Firebase, Firebase Admin SDK или FCM HTTP v1 API. Консоль Firebase позволяет проводить A/B-тестирование на основе аналитики, чтобы вы могли улучшать свои уведомления.

Чтобы отправлять уведомления с помощью Firebase Admin SDK или FCM HTTP v1 API, задайте ключ notification с предопределенным набором параметров "ключ-значение" для уведомления. Ниже приведен пример форматирования уведомления в приложении для мгновенного обмена сообщениями.

{
  "message":{
    "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
    "notification":{
      "title":"Portugal vs. Denmark",
      "body":"great match!"
    }
  }
}

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

Полный список предопределенных ключей, доступных для создания уведомлений, можно найти в справочной документации по объекту уведомлений FCM HTTP v1 API.

Сообщения с данными

Вы можете использовать полезную нагрузку FCM data для реализации выбранной схемы шифрования. Убедитесь, что в ваших парах "ключ-значение" нет зарезервированных слов. К зарезервированным словам относятся from, message_type и любые слова, начинающиеся с google., gcm. или gcm.notification..

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

{
  "message":{
    "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
    "data":{
      "Nick" : "Mario",
      "body" : "great match!",
      "Room" : "PortugalVSDenmark"
    }
  }
}

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

Вы можете отправлять уведомления, содержащие необязательную полезную нагрузку в виде пар "ключ-значение", программно или с помощью консоли Firebase. В Компоновщике уведомлений используйте поля Специальные данные в разделе Дополнительные настройки.

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

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

Ниже приведен пример сообщения в формате JSON, содержащего ключи notification и data.

{
  "message":{
    "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
    "notification":{
      "title":"Portugal vs. Denmark",
      "body":"great match!"
    },
    "data" : {
      "Nick" : "Mario",
      "Room" : "PortugalVSDenmark"
    }
  }
}