Protocole HTTP de 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 le destinataire d'un message de multidiffusion, c'est-à-dire un message envoyé à plusieurs jetons d'enregistrement.

La valeur doit être un tableau de jetons d'enregistrement auxquels envoyer le message multicast. Le tableau doit contenir au moins un et au plus 1 000 jetons d'enregistrement. Pour envoyer un message à un seul appareil, utilisez le paramètre to.

Les messages multicast ne sont autorisés qu'au format JSON HTTP.

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

Condition acceptée : "Topic", au format "'votreTopic' dans les sujets". Cette valeur n'est pas sensible à la casse.

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

Ce paramètre est obsolète. Utilisez plutôt to pour spécifier les destinataires des messages. Pour en savoir plus sur l'envoi de messages à plusieurs appareils, consultez la documentation de votre plate-forme.

Ce paramètre identifie un groupe de messages (par exemple, avec collapse_key: "Updates Available") pouvant être réduits, de sorte que seul le dernier message est envoyé lorsque la distribution peut être réactivée. Cela permet d'éviter d'envoyer trop de messages identiques lorsque l'appareil revient en ligne ou devient actif.

Notez que 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 les quatre clés de réduction FCM conserveront.

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 l'utilisation de la batterie de l'application cliente et doit être utilisée à moins qu'une livraison immédiate ne soit 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. Elles peuvent dépendre de facteurs tels que l'activation du mode Économie d'énergie par l'utilisateur, la fermeture forcée de l'application, etc. Sous Android, les messages de données activent 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.

Lorsqu'il est défini sur true, ce paramètre permet aux développeurs de tester une requête sans envoyer réellement de message.

La valeur par défaut est false.

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

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

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

Sur Android, cela entraînerait 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.

S'il n'est pas spécifié, le badge n'est pas modifié.

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

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

Correspond à category dans la charge utile APNs.

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 les sections Documentation de référence sur les clés de charge utile et Localiser le contenu de vos notifications à distance.

Valeurs de chaîne variable à 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 APNs.

Pour en savoir plus, consultez les sections 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 APNs.

Pour en savoir plus, consultez les sections 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 APNs.

Pour en savoir plus, consultez les sections 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 canal 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.

Accepte "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.

S'il n'est pas spécifié, 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 de variable à utiliser à la place des spécificateurs de format dans body_loc_key pour localiser le corps du texte dans 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 de variable à utiliser à la place des spécificateurs de format dans title_loc_key pour localiser le texte du titre dans 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 les applications clientes (jetons d'enregistrement) qui reçoivent le message.

La messagerie multidiffusion (envoi à plusieurs jetons d'enregistrement) n'est autorisée qu'au format JSON HTTP.

Ce paramètre spécifie les paires clé-valeur de la charge utile du message. Le nombre de paramètres clé-valeur n'est pas limité, mais la taille totale du message est limitée à 4 096 octets.

Par exemple, sous Android, "data.score"."3x1" 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é ("de", "type_message", ni tout mot commençant par "google" ou "gcm"). N'utilisez aucun des mots définis dans ce tableau (par exemple, collapse_key).

• message_id : chaîne spécifiant un ID unique pour chaque message traité avec succès.
• error : chaîne spécifiant l'erreur qui s'est produite lors du traitement du message pour le destinataire. Les valeurs possibles figurent dans le tableau 9.

• 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 le service de commentaires APNs a signalé que le jeton APNs était 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 iOS).
• Si l'application cliente est mise à jour, mais que la nouvelle version n'est pas configurée pour recevoir des messages.

• L'en-tête d'autorisation est manquant ou sa syntaxe est incorrecte dans la requête HTTP.
• Le projet Firebase auquel appartient la clé de serveur spécifiée est incorrect.
• Clés de serveur anciennes uniquement : la requête provient d'un serveur qui ne figure pas dans la liste d'autorisation des adresses IP de la clé de serveur.

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

• Respectez l'en-tête Retry-After s'il est inclus dans la réponse du serveur de connexion FCM.
• 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 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.

Les expéditeurs qui causent des problèmes risquent d'être ajoutés à la liste noire.

Le nombre de messages envoyés à un appareil spécifique est trop élevé. Si une application Apple envoie des messages à un débit supérieur aux limites APNs, elle peut recevoir ce message d'erreur.

Réduisez le nombre de messages envoyés à cet appareil et utilisez un intervalle exponentiel entre les tentatives d'envoi.