Protocole XMPP Firebase Cloud Messaging

Ce paramètre spécifie le destinataire d'un message.

La valeur peut être le jeton d'enregistrement d'un appareil, la clé de notification d'un groupe d'appareils ou un seul sujet (préfixé par /topics/). Pour envoyer des messages à plusieurs sujets, utilisez le paramètre condition.

Ce paramètre spécifie une expression logique de conditions qui détermine la cible du message.

Condition acceptée : "Topic", au format "'yourTopic' in topics". Cette valeur n'est pas sensible à la casse.

Opérateurs acceptés: &&, ||. Deux opérateurs maximum par message de sujet sont acceptés.

Ce paramètre identifie de manière unique un message dans une connexion XMPP.

Ce paramètre identifie un groupe de messages (par exemple, avec collapse_key: "Updates Available") qui peut être réduit afin que seul le dernier message soit envoyé lorsque la diffusion est reprise. Cela permet d'éviter d'envoyer trop de messages identiques lorsque l'appareil revient en ligne ou sort de la mise en veille.

L'ordre dans lequel les messages sont envoyés n'est pas garanti.

Remarque: Vous ne pouvez utiliser qu'un maximum de quatre clés de réduction différentes à la fois. Cela signifie que FCM peut stocker simultanément quatre messages différents par application cliente. Si vous dépassez ce nombre, il n'est pas garanti que FCM conserve les quatre clés de réduction.

Définit la priorité du message. Les valeurs valides sont "normal" (normal) et "high" (élevé). Sur les plates-formes Apple, elles correspondent aux priorités 5 et 10 des notifications APN.

Par défaut, les messages de notification sont envoyés avec une priorité élevée, et les messages de données sont envoyés avec une priorité normale. La priorité normale optimise la consommation de la batterie de l'application cliente et doit être utilisée, sauf si une diffusion immédiate est requise. Pour les messages de priorité normale, l'application peut recevoir le message avec un délai non spécifié.

Lorsqu'un message est envoyé avec une priorité élevée, il est envoyé immédiatement et l'application peut afficher une notification.

Sur les plates-formes Apple, utilisez ce champ pour représenter content-available dans la charge utile des APN. Lorsqu'une notification ou un message est envoyé et que cette valeur est définie sur true, une application cliente inactive est activée et le message est envoyé via les APN en tant que notification silencieuse et non via FCM. Notez que la diffusion des notifications silencieuses dans les APN n'est pas garantie et peut dépendre de facteurs tels que l'activation du mode économie d'énergie par l'utilisateur, la fermeture forcée de l'application, etc. Sur Android, les messages de données réveillent l'application par défaut. Dans Chrome, ce n'est actuellement pas possible.

Sur les plates-formes Apple, utilisez ce champ pour représenter mutable-content dans la charge utile des APN. Lorsqu'une notification est envoyée et qu'elle est définie sur true, le contenu de la notification peut être modifié avant son affichage à l'aide d'une extension d'application Notification Service. Ce paramètre sera ignoré pour Android et le Web.

Ce paramètre spécifie la durée (en secondes) pendant laquelle le message doit être conservé dans l'espace de stockage FCM si l'appareil est hors connexion. La valeur TTL maximale acceptée est de quatre semaines, et la valeur par défaut est de quatre semaines. Pour en savoir plus, consultez Définir la durée de vie d'un message.

Lorsque ce paramètre est défini sur true, les développeurs peuvent tester une requête sans envoyer de message.

La valeur par défaut est false.

Ce paramètre spécifie les paires clé-valeur de la charge utile du message.

Par exemple, avec data:{"score":"3x1"}:

Sur les plates-formes Apple, si le message est envoyé par les APN, il représente les champs de données personnalisés. S'il est fourni par FCM, il est représenté sous la forme d'un dictionnaire de clés-valeurs dans AppDelegate application:didReceiveRemoteNotification:.

Sur Android, cela génère un intent supplémentaire nommé score avec la valeur de chaîne 3x1.

La clé ne doit pas être un mot réservé ("from", "message_type" ou tout mot commençant par "google" ou "gcm"). N'utilisez aucun des mots définis dans ce tableau (par exemple, collapse_key).

Nous vous recommandons d'utiliser des valeurs de type chaîne. Vous devez convertir les valeurs d'objets ou d'autres types de données autres que des chaînes (par exemple, des entiers ou des valeurs booléennes) en chaînes.

Titre de la notification.

Ce champ n'est pas visible sur les téléphones et les tablettes.

Corps du texte de la notification.

Son à lire lorsque l'appareil reçoit la notification.

Chaîne spécifiant les fichiers audio dans le bundle principal de l'application cliente ou dans le dossier Library/Sounds du conteneur de données de l'application. Pour en savoir plus, consultez la bibliothèque des développeurs iOS.

Valeur du badge sur l'icône de l'application sur l'écran d'accueil.

Si cette option n'est pas spécifiée, le badge ne change pas.

Si la valeur est 0, le badge est supprimé.

Action associée à un clic de l'utilisateur sur la notification.

Correspond à category dans la charge utile des APN.

Sous-titre de la notification.

Clé de la chaîne de corps dans les ressources de chaîne de l'application à utiliser pour localiser le texte du corps en fonction de la localisation actuelle de l'utilisateur.

Correspond à loc-key dans la charge utile des APN.

Pour en savoir plus, consultez la Documentation de référence sur les clés de charge utile et Localiser le contenu de vos notifications à distance.

Valeurs de chaîne variables à utiliser à la place des spécificateurs de format dans body_loc_key pour localiser le texte du corps en fonction de la localisation actuelle de l'utilisateur.

Correspond à loc-args dans la charge utile des APN.

Pour en savoir plus, consultez la Documentation de référence sur les clés de charge utile et Localiser le contenu de vos notifications à distance.

Clé de la chaîne de titre dans les ressources de chaîne de l'application à utiliser pour localiser le texte du titre en fonction de la localisation actuelle de l'utilisateur.

Correspond à title-loc-key dans la charge utile des APN.

Pour en savoir plus, consultez la Documentation de référence sur les clés de charge utile et Localiser le contenu de vos notifications à distance.

Valeurs de chaîne variables à utiliser à la place des spécificateurs de format dans title_loc_key pour localiser le texte du titre en fonction de la localisation actuelle de l'utilisateur.

Correspond à title-loc-args dans la charge utile des APN.

Pour en savoir plus, consultez la Documentation de référence sur les clés de charge utile et Localiser le contenu de vos notifications à distance.

Titre de la notification.

Corps du texte de la notification.

ID de canal de la notification (nouveauté d'Android O)

L'application doit créer un canal avec cet ID de canal avant de recevoir une notification avec cet ID de canal.

Si vous n'envoyez pas cet ID de chaîne dans la requête ou si l'ID de chaîne fourni n'a pas encore été créé par l'application, FCM utilise l'ID de chaîne spécifié dans le fichier manifeste de l'application.

Icône de la notification.

Définit l'icône de notification sur myicon pour la ressource drawable myicon. Si vous n'envoyez pas cette clé dans la requête, FCM affiche l'icône du lanceur spécifiée dans le fichier manifeste de votre application.

Son à lire lorsque l'appareil reçoit la notification.

Compatible avec "default" ou le nom de fichier d'une ressource audio groupée dans l'application. Les fichiers audio doivent se trouver dans /res/raw/.

Identifiant utilisé pour remplacer les notifications existantes dans le panneau des notifications.

Si elle n'est pas spécifiée, chaque requête crée une notification.

Si vous spécifiez cette valeur et qu'une notification avec la même balise est déjà affichée, la nouvelle notification remplace l'ancienne dans le panneau des notifications.

Couleur de l'icône de la notification, exprimée au format #rrggbb.

Action associée à un clic de l'utilisateur sur la notification.

Si spécifié, une activité avec un filtre d'intent correspondant est lancée lorsqu'un utilisateur clique sur la notification.

Clé de la chaîne de corps dans les ressources de chaîne de l'application à utiliser pour localiser le texte du corps en fonction de la localisation actuelle de l'utilisateur.

Pour en savoir plus, consultez la section Ressources de chaîne.

Valeurs de chaîne variables à utiliser à la place des spécificateurs de format dans body_loc_key pour localiser le texte du corps en fonction de la localisation actuelle de l'utilisateur.

Pour en savoir plus, consultez la section Mise en forme et style.

Clé de la chaîne de titre dans les ressources de chaîne de l'application à utiliser pour localiser le texte du titre en fonction de la localisation actuelle de l'utilisateur.

Pour en savoir plus, consultez la section Ressources de chaîne.

Valeurs de chaîne variables à utiliser à la place des spécificateurs de format dans title_loc_key pour localiser le texte du titre en fonction de la localisation actuelle de l'utilisateur.

Pour en savoir plus, consultez la section Mise en forme et style.

Titre de la notification.

Corps du texte de la notification.

URL à utiliser pour l'icône de la notification.

Action associée à un clic de l'utilisateur sur la notification.

Pour toutes les valeurs d'URL, HTTPS est obligatoire.

Ce paramètre spécifie qui a envoyé cette réponse.

La valeur correspond au jeton d'enregistrement de l'application cliente.

Ce paramètre spécifie un message ack ou nack de FCM au serveur d'application.

Si la valeur est définie sur nack, le serveur d'application doit examiner error et error_description pour obtenir des informations sur l'échec.

• Si l'application cliente se désinscrit auprès de FCM.
• Si l'application cliente est automatiquement désenregistrée, ce qui peut se produire si l'utilisateur désinstalle l'application. Par exemple, sur iOS, si APNs a signalé le jeton APNs comme non valide.
• Si le jeton d'enregistrement expire (par exemple, Google peut décider d'actualiser les jetons d'enregistrement ou le jeton APN a expiré pour les appareils).
• Si l'application cliente est mise à jour, mais que la nouvelle version n'est pas configurée pour recevoir des messages.

Le serveur n'a pas pu traiter la requête à temps. Réessayez la même requête, mais vous devez:

• Implémentez un intervalle exponentiel entre les tentatives dans votre mécanisme de nouvelle tentative. (par exemple, si vous avez attendu une seconde avant la première nouvelle tentative, attendez au moins deux secondes avant la suivante, puis quatre secondes, et ainsi de suite). Si vous envoyez plusieurs messages, retardez chacun d'eux indépendamment d'une valeur aléatoire supplémentaire pour éviter d'émettre une nouvelle requête pour tous les messages en même temps.
• Le délai de nouvelle tentative initial doit être défini sur une seconde.

Remarque: Les expéditeurs qui posent problème risquent d'être ajoutés à la liste de blocage.

Ce paramètre indique qui a envoyé le message.

La valeur correspond au jeton d'enregistrement de l'application cliente.

Ce paramètre spécifie le destinataire d'un message de réponse.

La valeur doit être un jeton d'enregistrement de l'application cliente qui a envoyé le message en amont.

Ce paramètre spécifie le type de message: commande.

Lorsqu'il est défini sur control, le message inclut control_type pour indiquer le type de message de contrôle.

Ce paramètre spécifie le type de message de contrôle envoyé à partir de FCM.

Pour le moment, seul le type CONNECTION_DRAINING est compatible. FCM envoie ce message de contrôle avant de fermer une connexion pour effectuer l'équilibrage de charge. Lorsque la connexion est épuisée, aucun message ne peut plus être envoyé à la connexion, mais les messages existants dans le pipeline continuent d'être traités.