Catch up on highlights from Firebase at Google I/O 2023. Learn more

Senden Sie Nachrichten an Gerätegruppen auf Android

Mithilfe von Gerätegruppen-Messaging können Sie mehrere Geräte zu einer einzelnen Gruppe hinzufügen. Dies ähnelt dem Thema Messaging, umfasst jedoch eine Authentifizierung, um sicherzustellen, dass die Gruppenmitgliedschaft nur von Ihren Servern verwaltet wird. Wenn Sie beispielsweise unterschiedliche Nachrichten an unterschiedliche Telefonmodelle senden möchten, können Ihre Server Registrierungen zu den entsprechenden Gruppen hinzufügen/entfernen und die entsprechende Nachricht an jede Gruppe senden. Der Unterschied zwischen Gerätegruppen-Messaging und Themen-Messaging besteht darin, dass Gerätegruppen von Ihren Servern aus verwaltet werden müssen und nicht direkt in Ihrer Anwendung.

Sie können Gerätegruppen-Messaging über die alten XMPP- oder HTTP- Protokolle auf Ihrem App-Server verwenden. Ältere Versionen des Firebase Admin SDK für Node.js basieren auf den Legacy-Protokollen und bieten auch Gerätegruppen-Messaging-Funktionen. Die maximal zulässige Anzahl von Mitgliedern für einen Benachrichtigungsschlüssel beträgt 20.

Gerätegruppen verwalten

Bevor Sie Nachrichten an eine Gerätegruppe senden, müssen Sie:

  1. Erhalten Sie Registrierungstoken für jedes Gerät, das Sie der Gruppe hinzufügen möchten.

  2. Erstellen Sie den notification_key , der die Gerätegruppe identifiziert, indem eine bestimmte Gruppe (normalerweise ein Benutzer) allen zugehörigen Registrierungstokens der Gruppe zugeordnet wird. Sie können Benachrichtigungsschlüssel auf dem App-Server erstellen.

Die grundlegende Verwaltung von Gerätegruppen – das Erstellen und Entfernen von Gruppen sowie das Hinzufügen oder Entfernen von Geräten – erfolgt über den App-Server. Eine Liste der unterstützten Schlüssel finden Sie in der Referenz zum Legacy-HTTP-Protokoll .

Verwalten von Gerätegruppen auf dem App-Server

Erstellen einer Gerätegruppe

Um eine Gerätegruppe zu erstellen, senden Sie eine POST-Anfrage, die einen Namen für die Gruppe und eine Liste von Registrierungstokens für die Geräte bereitstellt. FCM gibt einen neuen notification_key zurück, der die Gerätegruppe darstellt.

HTTP-POST-Anfrage

Senden Sie eine Anfrage wie die folgende an https://fcm.googleapis.com/fcm/notification :

https://fcm.googleapis.com/fcm/notification
Content-Type:application/json
Authorization:key=API_KEY
project_id:SENDER_ID

{
   "operation": "create",
   "notification_key_name": "appUser-Chris",
   "registration_ids": ["bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
                        "cR1rjyj4_Kc:APA91bGusqbypSuMdsh7jSNrW4nzsM...",
                        ... ]

Der notification_key_name ist ein Name oder Bezeichner (z. B. ein Benutzername), der für eine bestimmte Gruppe eindeutig ist. notification_key_name und notification_key sind für eine Gruppe von Registrierungstokens eindeutig. Es ist wichtig, dass notification_key_name für jede Client-App eindeutig ist, wenn Sie mehrere Client-Apps für dieselbe Absender-ID haben. Dadurch wird sichergestellt, dass Nachrichten nur an die vorgesehene Ziel-App gehen.

Antwortformat

Eine erfolgreiche Anfrage gibt einen notification_key wie den folgenden zurück:

{
   "notification_key": "APA91bGHXQBB...9QgnYOEURwm0I3lmyqzk2TXQ"
}

Speichern Sie den notification_key und den entsprechenden notification_key_name , um sie in nachfolgenden Vorgängen zu verwenden.

Abrufen eines Benachrichtigungsschlüssels

Wenn Sie einen vorhandenen Benachrichtigungsschlüssel abrufen müssen, verwenden Sie den notification_key_name in einer GET-Anfrage wie gezeigt:

https://fcm.googleapis.com/fcm/notification?notification_key_name=appUser-Chris
Content-Type:application/json
Authorization:key=API_KEY
project_id:SENDER_ID
{}

Für jede GET-Anfrage für einen bestimmten Benachrichtigungsschlüsselnamen gibt der Server eine eindeutige codierte Zeichenfolge zurück. Auch wenn jede Zeichenfolge wie ein anderer Schlüssel aussieht, handelt es sich tatsächlich um einen gültigen „notification_key“-Wert.

Hinzufügen und Entfernen von Geräten zu einer Gerätegruppe

Um Geräte zu einer vorhandenen Gruppe hinzuzufügen oder daraus zu entfernen, senden Sie eine POST-Anfrage mit dem operationadd oder remove und stellen Sie die Registrierungstoken zum Hinzufügen oder Entfernen bereit.

HTTP-POST-Anfrage

Um beispielsweise ein Gerät mit dem Registrierungstoken bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1... zu appUser-Chris hinzuzufügen, würden Sie diese Anfrage senden:

{
   "operation": "add",
   "notification_key_name": "appUser-Chris",
   "notification_key": "APA91bGHXQBB...9QgnYOEURwm0I3lmyqzk2TXQ",
   "registration_ids": ["bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."]
}

Antwortformat

Eine erfolgreiche Anfrage zum Hinzufügen oder Entfernen eines Geräts gibt einen notification_key wie den folgenden zurück:

{
   "notification_key": "APA91bGHXQBB...9QgnYOEURwm0I3lmyqzk2TXQ"
}

Senden von Downstream-Nachrichten an Gerätegruppen

Das Senden von Nachrichten an eine Gerätegruppe ähnelt dem Senden von Nachrichten an ein einzelnes Gerät. Legen Sie den to Parameter auf den eindeutigen Benachrichtigungsschlüssel für die Gerätegruppe fest. Einzelheiten zur Nutzlastunterstützung finden Sie unter Nachrichtentypen . Beispiele auf dieser Seite zeigen, wie Datennachrichten an Gerätegruppen in den alten HTTP- und XMPP-Protokollen gesendet werden.

HTTP-POST-Anfrage der Gerätegruppe

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{
  "to": "aUniqueKey",
  "data": {
    "hello": "This is a Firebase Cloud Messaging Device Group Message!",
   }
}

HTTP-Antwort der Gerätegruppe

Hier ist ein Beispiel für „Erfolg“ – dem notification_key sind zwei Registrierungstoken zugeordnet und die Nachricht wurde erfolgreich an beide gesendet:

{
  "success": 2,
  "failure": 0
}

Hier ist ein Beispiel für einen „Teilerfolg“ – mit dem notification_key sind drei Registrierungstoken verknüpft. Die Nachricht wurde nur an eines der Registrierungstokens erfolgreich gesendet. Die Antwortnachricht listet die Registrierungstoken ( registration_ids ) auf, die die Nachricht nicht empfangen konnten:

{
  "success":1,
  "failure":2,
  "failed_registration_ids":[
     "regId1",
     "regId2"
  ]
}

Wenn eine Nachricht nicht an eines oder mehrere der mit einem notification_key verknüpften Registrierungstokens übermittelt werden kann, sollte der App-Server es mit Backoff zwischen den Wiederholungsversuchen erneut versuchen.

Wenn der Server versucht, eine Nachricht an eine Gerätegruppe zu senden, die keine Mitglieder hat, sieht die Antwort wie folgt aus, mit 0 Erfolg und 0 Fehler:

{
  "success": 0,
  "failure": 0
}

XMPP-Nachricht der Gerätegruppe

<message id="">
  <gcm xmlns="google:mobile:data">
  {
      "to": "aUniqueKey",
      "message_id": "m-1366082849205" ,
      "data": {
          "hello":"This is a Firebase Cloud Messaging Device Group Message!"
      }
  }
  </gcm>
</message>

XMPP-Antwort der Gerätegruppe

Wenn die Nachricht erfolgreich an eines der Geräte in der Gruppe gesendet wurde, antwortet der XMPP-Verbindungsserver mit einer Bestätigung. Wenn alle an alle Geräte in der Gruppe gesendeten Nachrichten fehlschlagen, antwortet der XMPP-Verbindungsserver mit einem NACK.

Hier ist ein Beispiel für „Erfolg“ – dem notification_key sind drei Registrierungstoken zugeordnet und die Nachricht wurde erfolgreich an alle gesendet:

{
  "from": "aUniqueKey",
  "message_type": "ack",
  "success": 3,
  "failure": 0,
  "message_id": "m-1366082849205"
}

Hier ist ein Beispiel für einen „Teilerfolg“ – mit dem notification_key sind drei Registrierungstoken verknüpft. Die Nachricht wurde nur an eines der Registrierungstokens erfolgreich gesendet. Die Antwortnachricht listet die Registrierungstoken auf, die die Nachricht nicht empfangen konnten:

{
  "from": "aUniqueKey",
  "message_type": "ack",
  "success":1,
  "failure":2,
  "failed_registration_ids":[
     "regId1",
     "regId2"
  ]
}

Wenn der FCM-Verbindungsserver nicht alle Geräte in der Gruppe beliefern kann. Der App-Server erhält eine Nack-Antwort.

Die vollständige Liste der Nachrichtenoptionen finden Sie in den Referenzinformationen für das von Ihnen gewählte Verbindungsserverprotokoll ( HTTP oder XMPP) .