HTTP-протокол Firebase Cloud Messaging

Этот параметр указывает получателя сообщения.

Значением может быть токен регистрации устройства, ключ уведомления группы устройств или отдельная тема (с префиксом /topics/ ). Чтобы отправить сообщение в несколько тем, используйте параметр condition .

Этот параметр указывает получателя многоадресного сообщения — сообщения, отправленного более чем на один регистрационный токен.

Значением должен быть массив регистрационных токенов, на которые будет отправлено многоадресное сообщение. Массив должен содержать от 1 до 1000 токенов регистрации. Чтобы отправить сообщение на одно устройство, используйте параметр to .

Многоадресные сообщения разрешены только в формате HTTP JSON.

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

Поддерживаемое условие: тема в темах имеет формат «ваша тема». Это значение нечувствительно к регистру.

Поддерживаемые операторы: && , || . Поддерживается максимум два оператора на сообщение темы.

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

Этот параметр идентифицирует группу сообщений (например, с collapse_key: "Updates Available" ), которые можно свернуть, чтобы при возобновлении доставки отправлялось только последнее сообщение. Это сделано для того, чтобы избежать отправки слишком большого количества одних и тех же сообщений, когда устройство снова подключается к сети или становится активным.

Обратите внимание, что нет никакой гарантии порядка отправки сообщений.

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

Устанавливает приоритет сообщения. Допустимые значения: «нормальный» и «высокий». На платформах Apple они соответствуют приоритетам APN 5 и 10.

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

Когда сообщение отправляется с высоким приоритетом, оно отправляется немедленно, и приложение может отображать уведомление.

На платформах Apple используйте это поле для представления content-available в полезной нагрузке APN. Когда отправляется уведомление или сообщение, и для этого параметра установлено значение true , неактивное клиентское приложение просыпается, и сообщение отправляется через APN как автоматическое уведомление, а не через FCM . Обратите внимание, что доставка беззвучных уведомлений в APN не гарантируется и может зависеть от таких факторов, как включение пользователем режима энергосбережения, принудительный выход из приложения и т. д. На Android сообщения с данными пробуждают приложение по умолчанию. В Chrome в настоящее время не поддерживается.

На платформах Apple используйте это поле для представления mutable-content в полезной нагрузке APN. Если уведомление отправлено и для него установлено значение true , содержимое уведомления можно изменить перед его отображением с помощью расширения приложения службы уведомлений . Этот параметр будет игнорироваться для Android и Интернета.

Этот параметр указывает, как долго (в секундах) сообщение должно храниться в хранилище FCM , если устройство находится в автономном режиме. Максимальное время поддержки — 4 недели, значение по умолчанию — 4 недели. Дополнительную информацию см. в разделе Настройка срока действия сообщения .

Если для этого параметра установлено значение true , разработчики могут протестировать запрос без фактической отправки сообщения.

Значение по умолчанию — false .

Этот параметр указывает пользовательские пары «ключ-значение» полезных данных сообщения.

Например, с data:{"score":"3x1"}:

На платформах Apple, если сообщение отправляется через APN, оно представляет собой настраиваемые поля данных. Если он отправляется через FCM , он будет представлен как словарь значений ключей в AppDelegate application:didReceiveRemoteNotification:

В Android это приведет к созданию дополнительной именованной score со строковым значением 3x1 .

Ключ не должен быть зарезервированным словом («from», «message_type» или любым словом, начинающимся с «google» или «gcm»). Не используйте слова, определенные в этой таблице (например, collapse_key ).

Рекомендуется использовать значения строкового типа. Вам необходимо преобразовать значения в объектах или других нестроковых типах данных (например, целые или логические значения) в строку.

Название уведомления.

Это поле не отображается на телефонах и планшетах.

Текст уведомления.

Звук, который воспроизводится, когда устройство получает уведомление.

Строка, определяющая звуковые файлы в основном пакете клиентского приложения или в папке Library/Sounds контейнера данных приложения. Дополнительную информацию см. в библиотеке разработчиков iOS .

Значение значка на значке приложения на главном экране.

Если не указано, значок не изменяется.

Если установлено значение 0 , значок удаляется.

Действие, связанное с щелчком пользователя по уведомлению.

Соответствует category в полезных данных APN.

Подзаголовок уведомления.

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

Соответствует loc-key в полезной нагрузке APN.

Дополнительные сведения см. в разделе «Справочник по ключам полезной нагрузки» и «Локализация содержимого удаленных уведомлений» .

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

Соответствует loc-args в полезных данных APN.

Дополнительные сведения см. в разделе «Справочник по ключам полезной нагрузки» и «Локализация содержимого удаленных уведомлений» .

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

Соответствует title-loc-key в полезных данных APN.

Дополнительные сведения см. в разделе «Справочник по ключам полезной нагрузки» и «Локализация содержимого удаленных уведомлений» .

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

Соответствует title-loc-args в полезных данных APN.

Дополнительные сведения см. в разделе «Справочник по ключам полезной нагрузки» и «Локализация содержимого удаленных уведомлений» .

Название уведомления.

Текст уведомления.

Идентификатор канала уведомления (новое в Android O).

Приложение должно создать канал с этим идентификатором канала, прежде чем будет получено какое-либо уведомление с этим идентификатором канала.

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

Значок уведомления.

Устанавливает значок уведомления myicon для рисуемого ресурса myicon . Если вы не отправите этот ключ в запросе, FCM отобразит значок средства запуска, указанный в манифесте вашего приложения.

Звук, который воспроизводится, когда устройство получает уведомление.

Поддерживает "default" или имя файла звукового ресурса, включенного в приложение. Звуковые файлы должны находиться в /res/raw/ .

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

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

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

Цвет значка уведомления, выраженный в формате #rrggbb .

Действие, связанное с щелчком пользователя по уведомлению.

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

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

Дополнительную информацию см. в разделе «Строковые ресурсы» .

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

Дополнительную информацию см. в разделе «Форматирование и оформление» .

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

Дополнительные сведения см. в разделе «Строковые ресурсы» .

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

Дополнительную информацию см. в разделе «Форматирование и оформление» .

Название уведомления.

Текст уведомления.

URL-адрес, который будет использоваться для значка уведомления.

Действие, связанное с щелчком пользователя по уведомлению.

Для всех значений URL требуется HTTPS.

Этот параметр указывает клиентские приложения (токены регистрации), получающие сообщение.

Многоадресная рассылка сообщений (отправка более чем на один регистрационный токен) разрешена только с использованием формата HTTP JSON.

Этот параметр определяет пары ключ-значение полезных данных сообщения. Ограничений на количество параметров «ключ-значение» нет, но общий размер сообщения ограничен 4096 байтами.

Например, в Android "data.score"."3x1" приведет к получению дополнительного именованного score намерения со строковым значением 3x1 .

Ключ не должен быть зарезервированным словом («from», «message_type» или любым словом, начинающимся с «google» или «gcm»). Не используйте слова, определенные в этой таблице (например, collapse_key ).

• message_id : строка, определяющая уникальный идентификатор для каждого успешно обработанного сообщения.
• error : строка, указывающая ошибку, произошедшую при обработке сообщения для получателя. Возможные значения можно найти в таблице 9 .

• Если клиентское приложение отменяет регистрацию в FCM .
• Если клиентское приложение автоматически отменяется регистрации, что может произойти, если пользователь удалит приложение. Например, в iOS служба обратной связи APNs сообщила, что токен APNs недействителен.
• Если срок действия токена регистрации истек (например, Google может принять решение обновить токены регистрации или срок действия токена APNs для устройств iOS истек).
• Если клиентское приложение обновлено, но новая версия не настроена на получение сообщений.

• Заголовок авторизации отсутствует или имеет неверный синтаксис в HTTP-запросе.
• Проект Firebase, к которому принадлежит указанный ключ сервера, неверен.
• Только ключи устаревшего сервера — запрос исходит от сервера, не внесенного в белый список в IP-адресах ключей сервера.

Сервер не смог вовремя обработать запрос. Повторите тот же запрос, но необходимо:

• Учитывайте заголовок Retry-After , если он включен в ответ сервера соединений FCM .
• Внедрите экспоненциальную отсрочку в механизме повторных попыток. (например, если вы подождали одну секунду перед первой повторной попыткой, подождите не менее двух секунд перед следующей, затем 4 секунды и так далее). Если вы отправляете несколько сообщений, задержите каждое из них независимо на дополнительную случайную величину, чтобы избежать одновременной отправки нового запроса для всех сообщений.

Отправители, вызывающие проблемы, рискуют попасть в черный список.

Скорость отправки сообщений на конкретное устройство слишком высока. Если приложение Apple отправляет сообщения со скоростью, превышающей ограничения APN, оно может получить это сообщение об ошибке.

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