Firebase Cloud Messaging-HTTP-Protokoll

Dieser Parameter gibt den Empfänger einer Nachricht an.

Der Wert kann das Registrierungstoken eines Geräts, der Benachrichtigungsschlüssel einer Gerätegruppe oder ein einzelnes Thema sein (mit dem Präfix /topics/). Wenn Sie an mehrere Themen senden möchten, verwenden Sie den Parameter condition.

Dieser Parameter gibt den Empfänger einer Multicast-Nachricht an, also einer Nachricht, die an mehr als ein Registrierungstoken gesendet wird.

Der Wert sollte ein Array von Registrierungstokens sein, an die die Multicast-Nachricht gesendet werden soll. Das Array muss mindestens ein und höchstens 1.000 Registrierungstokens enthalten. Wenn du eine Nachricht an ein einzelnes Gerät senden möchtest, verwende den Parameter to.

Multicast-Nachrichten sind nur im HTTP-JSON-Format zulässig.

Dieser Parameter gibt einen logischen Ausdruck von Bedingungen an, die das Nachrichtenziel bestimmen.

Unterstützte Bedingung: „Thema“, formatiert als „'deinThema' in topics“. Bei diesem Wert wird die Groß- und Kleinschreibung nicht berücksichtigt.

Unterstützte Operatoren: &&, ||. Pro Themennachricht werden maximal zwei Operatoren unterstützt.

Dieser Parameter ist nicht mehr verfügbar. Verwenden Sie stattdessen to, um die Nachrichtenempfänger anzugeben. Weitere Informationen zum Senden von Nachrichten an mehrere Geräte finden Sie in der Dokumentation für Ihre Plattform.

Mit diesem Parameter wird eine Gruppe von Nachrichten (z. B. mit collapse_key: "Updates Available") identifiziert, die minimiert werden kann, sodass nur die letzte Nachricht gesendet wird, wenn die Zustellung fortgesetzt werden kann. Dadurch soll vermieden werden, dass zu viele identische Nachrichten gesendet werden, wenn das Gerät wieder online ist oder aktiv wird.

Die Reihenfolge, in der Nachrichten gesendet werden, kann nicht garantiert werden.

Hinweis: Es sind jeweils maximal vier verschiedene Minimierungsschaltflächen zulässig. Das bedeutet, dass FCM gleichzeitig vier verschiedene Nachrichten pro Clientanwendung speichern kann. Wenn Sie diese Zahl überschreiten, kann nicht garantiert werden, welche vier Minimierungsschlüssel FCM beibehalten.

Legt die Priorität der Nachricht fest. Gültige Werte sind "normal" und "high". Auf Apple-Plattformen entsprechen diese den APN-Prioritäten 5 und 10.

Standardmäßig werden Benachrichtigungen mit hoher Priorität und Datennachrichten mit normaler Priorität gesendet. Die normale Priorität optimiert den Akkuverbrauch der Client-App und sollte verwendet werden, sofern keine sofortige Bereitstellung erforderlich ist. Bei Nachrichten mit normaler Priorität empfängt die App die Nachricht möglicherweise mit einer nicht angegebenen Verzögerung.

Wenn eine Nachricht mit hoher Priorität gesendet wird, wird sie sofort gesendet und die App kann eine Benachrichtigung anzeigen.

Auf Apple-Plattformen wird dieses Feld für content-available in der APNs-Nutzlast verwendet. Wenn eine Benachrichtigung oder Nachricht gesendet wird und diese Option auf true festgelegt ist, wird eine inaktive Client-App geweckt und die Nachricht wird über APNs als stille Benachrichtigung und nicht über FCM gesendet. Die Zustellung von stillen Benachrichtigungen in APNs kann nicht garantiert werden und hängt von Faktoren wie dem Einschalten des Energiesparmodus oder dem erzwungenen Beenden der App ab. Unter Android wecken Datennachrichten die App standardmäßig auf. In Chrome wird die Funktion derzeit nicht unterstützt.

Auf Apple-Plattformen wird dieses Feld für mutable-content in der APNs-Nutzlast verwendet. Wenn eine Benachrichtigung gesendet wird und diese Einstellung auf true festgelegt ist, kann der Inhalt der Benachrichtigung mithilfe einer App-Erweiterung für den Benachrichtigungsdienst vor der Anzeige geändert werden. Dieser Parameter wird bei Android und im Web ignoriert.

Mit diesem Parameter wird angegeben, wie lange (in Sekunden) die Nachricht im FCM-Speicher aufbewahrt werden soll, wenn das Gerät offline ist. Die maximale Gültigkeitsdauer beträgt 4 Wochen und der Standardwert 4 Wochen. Weitere Informationen finden Sie unter Gültigkeitsdauer einer Nachricht festlegen.

Wenn dieser Parameter auf true gesetzt ist, können Entwickler eine Anfrage testen, ohne tatsächlich eine Nachricht zu senden.

Der Standardwert ist false.

Dieser Parameter gibt die benutzerdefinierten Schlüssel/Wert-Paare der Nachrichtennutzlast an.

Zum Beispiel mit data:{"score":"3x1"}:

Wenn die Nachricht auf Apple-Plattformen über APNs gesendet wird, entspricht sie den benutzerdefinierten Datenfeldern. Wenn es über FCM gesendet wird, wird es in AppDelegate application:didReceiveRemoteNotification: als Schlüssel/Wert-Wörterbuch dargestellt.

Unter Android würde dies zu einem Intent-Extra namens score mit dem Stringwert 3x1 führen.

Der Schlüssel darf kein reserviertes Wort sein ("from", "message_type" oder ein anderes Wort, das mit "google" oder "gcm" beginnt). Verwenden Sie keines der in dieser Tabelle definierten Wörter (z. B. collapse_key).

Werte in Stringtypen werden empfohlen. Sie müssen Werte in Objekten oder anderen Datentypen, die keine Strings sind (z. B. Ganzzahlen oder Boolesche Werte), in Strings konvertieren.

Der Titel der Benachrichtigung.

Auf Smartphones und Tablets ist dieses Feld nicht sichtbar.

Der Text der Benachrichtigung.

Der Ton, der abgespielt wird, wenn das Gerät die Benachrichtigung erhält.

String, der Audiodateien im Hauptbundle der Client-App oder im Ordner Library/Sounds des Datencontainers der App angibt. Weitere Informationen finden Sie in der iOS Developer Library.

Der Wert des Logos auf dem App-Symbol des Startbildschirms.

Wenn keine Angabe erfolgt, wird das Logo nicht geändert.

Wenn 0 festgelegt ist, wird das Logo entfernt.

Die Aktion, die mit einem Nutzerklick auf die Benachrichtigung verknüpft ist.

Entspricht category in der APNs-Nutzlast.

Der Untertitel der Benachrichtigung.

Der Schlüssel für den Textkörper in den Stringressourcen der App, mit dem der Textkörper in die aktuelle Lokalisierung des Nutzers übersetzt wird.

Entspricht loc-key in der APNs-Nutzlast.

Weitere Informationen finden Sie unter Referenz für Nutzlastschlüssel und Inhalte von Remotebenachrichtigungen lokalisieren.

Variable Stringwerte, die anstelle der Formatspezifizierer in body_loc_key verwendet werden, um den Textkörper für die aktuelle Lokalisierung des Nutzers zu lokalisieren.

Entspricht loc-args in der APNs-Nutzlast.

Weitere Informationen finden Sie unter Payload-Schlüsselreferenz und Inhalte von Remote-Benachrichtigungen lokalisieren.

Der Schlüssel für den Titelstring in den Stringressourcen der App, mit dem der Titeltext in die aktuelle Lokalisierung des Nutzers übersetzt wird.

Entspricht title-loc-key in der APNs-Nutzlast.

Weitere Informationen finden Sie unter Payload-Schlüsselreferenz und Inhalte von Remote-Benachrichtigungen lokalisieren.

Variable Stringwerte, die anstelle der Formatspezifizierer in title_loc_key verwendet werden, um den Titeltext für die aktuelle Lokalisierung des Nutzers zu lokalisieren.

Entspricht title-loc-args in der APNs-Nutzlast.

Weitere Informationen finden Sie unter Payload-Schlüsselreferenz und Inhalte von Remote-Benachrichtigungen lokalisieren.

Der Titel der Benachrichtigung.

Der Text der Benachrichtigung.

Die Kanal-ID der Benachrichtigung (neu in Android O).

Die App muss einen Kanal mit dieser Kanal-ID erstellen, bevor Benachrichtigungen mit dieser Kanal-ID empfangen werden.

Wenn du diese Kanal-ID nicht in der Anfrage sendest oder die angegebene Kanal-ID noch nicht von der App erstellt wurde, verwendet FCM die im App-Manifest angegebene Kanal-ID.

Das Benachrichtigungssymbol.

Das Benachrichtigungssymbol wird für die Zeichnen-Ressource myicon auf myicon festgelegt. Wenn du diesen Schlüssel nicht in der Anfrage sendest, zeigt FCM das in deinem App-Manifest angegebene Launcher-Symbol an.

Ton, der abgespielt wird, wenn das Gerät die Benachrichtigung empfängt

Unterstützt "default" oder den Dateinamen einer in der Anwendung gebündelten Audioressource. Sounddateien müssen in /res/raw/ gespeichert sein.

ID, die zum Ersetzen vorhandener Benachrichtigungen in der Benachrichtigungsleiste verwendet wird.

Wenn nicht angegeben, wird für jede Anfrage eine neue Benachrichtigung erstellt.

Wenn Sie ein Tag angeben und bereits eine Benachrichtigung mit demselben Tag angezeigt wird, ersetzt die neue Benachrichtigung die vorhandene im Benachrichtigungs-Schieberegler.

Die Symbolfarbe der Benachrichtigung im #rrggbb-Format.

Die mit einem Nutzerklick verknüpfte Aktion auf die Benachrichtigung.

Wenn angegeben, wird eine Aktivität mit einem übereinstimmenden Intent-Filter gestartet, wenn ein Nutzer auf die Benachrichtigung klickt.

Der Schlüssel für den Textstring in den Stringressourcen der App, der zum Lokalisieren des Textkörpers für die aktuelle Lokalisierung des Nutzers verwendet werden soll.

Weitere Informationen finden Sie unter Stringressourcen.

Variable Stringwerte, die anstelle der Formatanweisungen in body_loc_key verwendet werden, um den Textkörper an die aktuelle Lokalisierung des Nutzers anzupassen.

Weitere Informationen finden Sie unter Formatierung und Stil.

Der Schlüssel für den Titelstring in den Stringressourcen der App, der zum Lokalisieren des Titeltexts für die aktuelle Lokalisierung des Nutzers verwendet werden soll.

Weitere Informationen finden Sie unter Stringressourcen.

Variable Stringwerte, die anstelle der Formatanweisungen in title_loc_key verwendet werden, um den Titeltext an die aktuelle Lokalisierung des Nutzers anzupassen.

Weitere Informationen finden Sie unter Formatierung und Stil.

Der Titel der Benachrichtigung.

Der Text der Benachrichtigung.

Die URL für das Symbol der Benachrichtigung.

Die mit einem Nutzerklick verknüpfte Aktion auf die Benachrichtigung.

Für alle URL-Werte ist HTTPS erforderlich.

Dieser Parameter gibt die Client-Apps (Registrierungstokens) an, die die Nachricht erhalten.

Multicast-Nachrichten (die an mehrere Registrierungstokens gesendet werden) sind nur im HTTP-JSON-Format zulässig.

Dieser Parameter gibt die Schlüssel/Wert-Paare der Nachrichtennutzlast an. Es gibt keine Begrenzung für die Anzahl der Schlüssel/Wert-Paar-Parameter, aber die Gesamtgröße der Nachricht ist auf 4.096 Byte beschränkt.

In Android würde "data.score"."3x1" beispielsweise zu einem Intent-Extra namens score mit dem Stringwert 3x1 führen.

Der Schlüssel darf kein reserviertes Wort sein („from“, „message_type“ oder ein Wort, das mit „google“ oder „gcm“ beginnt). Verwenden Sie keines der in dieser Tabelle definierten Wörter (z. B. collapse_key).

• message_id: String, der eine eindeutige ID für jede erfolgreich verarbeitete Nachricht angibt.
• error: String, der den Fehler angibt, der bei der Verarbeitung der Nachricht für den Empfänger aufgetreten ist. Die möglichen Werte finden Sie in Tabelle 9.

• Die Client-App wird bei FCM abgemeldet.
• Die Registrierung der Client-App wird automatisch aufgehoben. Dies kann passieren, wenn der Nutzer die App deinstalliert. Beispielsweise wenn der APNs Feedback Service auf iOS-Geräten das APNs-Token als ungültig gemeldet hat.
• Wenn das Registrierungstoken abläuft (z. B. wenn Google entscheidet, Registrierungstokens zu aktualisieren, oder das APNs-Token für iOS-Geräte abgelaufen ist).
• Wenn die Client-App aktualisiert wurde, die neue Version aber nicht für den Empfang von Nachrichten konfiguriert ist.

• Autorisierungsheader fehlt oder in HTTP-Anfrage mit ungültiger Syntax.
• Das Firebase-Projekt, zu dem der angegebene Serverschlüssel gehört, ist falsch.
• Nur Legacy-Serverschlüssel: Die Anfrage stammt von einem Server, der nicht auf der weißen Liste der Serverschlüssel-IPs ist.

Der Server konnte die Anfrage nicht rechtzeitig verarbeiten. Wiederholen Sie dieselbe Anfrage. Beachten Sie dabei jedoch Folgendes:

• Berücksichtige den Retry-After-Header, wenn er in der Antwort vom FCM-Verbindungsserver enthalten ist.
• Implementieren Sie einen exponentiellen Backoff in Ihrem Wiederholungsmechanismus. Wenn Sie beispielsweise eine Sekunde vor dem ersten Versuch gewartet haben, warten Sie mindestens zwei Sekunden vor dem nächsten, dann vier Sekunden und so weiter. Wenn Sie mehrere Nachrichten senden, verzögern Sie jede einzeln um einen zusätzlichen zufälligen Wert, um zu vermeiden, dass für alle Nachrichten gleichzeitig eine neue Anfrage gesendet wird.

Absender, die Probleme verursachen, riskieren, auf die schwarze Liste gesetzt zu werden.

Die Rate der Nachrichten an ein bestimmtes Gerät ist zu hoch. Wenn eine Apple-App Nachrichten mit einer Rate sendet, die die APN-Limits überschreitet, wird möglicherweise diese Fehlermeldung ausgegeben.

Reduzieren Sie die Anzahl der an dieses Gerät gesendeten Nachrichten und verwenden Sie den exponentiellen Backoff, um den Sendeversuch zu wiederholen.