Mit Terminen aus Google Chat arbeiten

Auf dieser Seite wird erläutert, wie Google Chat-Apps Ereignisse in Google Chat empfangen und darauf reagieren können.

Ein Google Chat-Ereignis steht für eine Aktivität oder Änderung in Google Chat, z. B. eine neue Nachricht in einem Gruppenbereich. Ihre Chat-App kann Ereignisse verwenden, um zu verstehen, was passiert ist, und Maßnahmen zu ergreifen oder auf sinnvolle Weise auf Nutzer zu reagieren.

Hier einige Beispiele für die Verwendung von Ereignissen:

  • Sie können neue Nachrichten in einem Gruppenbereich beobachten und darauf reagieren, z. B. nach Schlüsselwörtern oder Wortgruppen suchen.
  • Sie können Nutzern eine Begrüßungsnachricht senden, wenn sie dem Gruppenbereich beitreten, um die Richtlinien für den Gruppenbereich zu erläutern oder Tipps zur effektiven Nutzung der Chat-App zu geben.
  • Chataktivitäten erfassen und analysieren So kannst du beispielsweise einen monatlichen Bericht zu neuen Mitgliedern oder zu den Nachrichten mit den meisten Reaktionen oder Antworten senden.
  • Plattformübergreifend kommunizieren So können Nutzer beispielsweise Nachrichten an Nutzer einer anderen Messaging-Plattform senden und von ihnen empfangen, ohne Google Chat verlassen zu müssen.

So funktionieren Ereignisse

Jedes Mal, wenn etwas in Google Chat passiert, wird eine Google Chat API-Ressource erstellt, aktualisiert oder gelöscht. Über Ereignisse werden Informationen zur Art der Aktivität und zur betroffenen Chat API-Ressource an Ihre Chat-App gesendet.

Beispiel dafür, wie eine in einem Google Chat-Bereich gepostete Nachricht ein Ereignis auslöst.
Abbildung 1. Ein Nutzer postet eine Nachricht in einem Chatbereich. Dadurch wird eine Message-Ressource erstellt. Chat erstellt dann ein Ereignis mit Daten zur neuen Nachricht.

In Google Chat werden Ereignisse nach Typ kategorisiert. Mit Ereignistypen können Sie nur die Informationen filtern und abrufen, die Sie benötigen, und ähnliche Aktivitäten auf dieselbe Weise verarbeiten.

In der folgenden Tabelle sehen Sie, wie sich eine Aktivität in Google Chat auf eine zugehörige Chat API-Ressource auswirkt und welche Art von Ereignis an Ihre Chat-App gesendet wird:

Aktivität Chat API-Ressource Ereignistyp
Ein Nutzer postet eine Nachricht in einem Google Chat-Bereich. Eine Message-Ressource wird erstellt. Neue Nachricht
Ein Nutzer wird zum Administrator eines Gruppenbereichs. Eine Membership-Ressource wird aktualisiert. Mitgliedschaft aktualisiert
Ein Nutzer reagiert auf eine Nachricht. Eine Reaction-Ressource wird erstellt. Neue Reaktion
Ein Nutzer verlässt einen Gruppenbereich. Eine Membership-Ressource wird gelöscht. Gelöschte Mitgliedschaft

Ereignisse von Google Chat empfangen

Ihre Chat-App kann Ereignisse auf folgende Arten empfangen:

  • Mit der Google Workspace Events API können Sie Ereignisse abonnieren, um sie in Echtzeit zu erhalten.
  • Rufen Sie die Chat API auf, um nach aktuellen Ereignissen zu suchen.

In der folgenden Tabelle werden die Unterschiede und Gründe für das Abfragen oder Abonnieren von Ereignissen erläutert:

Ereignisse abonnieren Ereignisse abfragen
Anwendungsfälle
  • Ereignisse in Echtzeit verarbeiten oder darauf reagieren
  • Sie können die Mitgliedschaftsaktivitäten von Nutzern im Blick behalten und neue Gruppenbereiche finden, die Sie beobachten möchten.
  • Ereignisse regelmäßig oder über einen Trigger verarbeiten oder darauf reagieren
  • Verpasste Ereignisse aus einem Abo abrufen (aufgrund eines Ausfalls oder eines inaktiven Abos)
API Google Workspace Events API Chat API
Ereignisquelle Gruppenbereiche und Nutzer Nur Gruppenbereiche
Unterstützte Ereignisse
  • Nachrichten
  • Mitgliedschaften
  • Reaktionen
  • Leerzeichen

Eine Liste der unterstützten Ereignistypen finden Sie in der Dokumentation zur Google Workspace Events API unter Ereignistypen zum Erstellen von Abos.
  • Nachrichten
  • Mitgliedschaften
  • Reaktionen
  • Leerzeichen

Eine Liste der unterstützten Ereignistypen finden Sie in der Referenzdokumentation der Chat API unter spaceEvents.
Ereignisformat Eine Google Cloud Pub/Sub-Nachricht, die gemäß der CloudEvent-Spezifikation formatiert ist. Weitere Informationen finden Sie unter Struktur von Google Workspace-Ereignissen. Eine Chat API-Ressource ( spaces.spaceEvent)
Ereignisdaten Base64-codierter String mit oder ohne Ressourcendaten. Beispiele für Nutzlasten finden Sie unter Ereignisdaten. JSON-Nutzlast mit Ressourcendaten. Einige Ereignistypen enthalten nur bestimmte Ressourcenfelder. Beispiel-Nutzlastdaten finden Sie in der Referenzdokumentation.

Beispiel: Abfragen oder abonnieren von Ereignissen zu Mitgliedschaften in einem Gruppenbereich

In diesem Beispiel möchte eine Chat-App Informationen zu Änderungen an den Mitgliedern eines Chatbereichs erhalten. Im Gruppenbereich werden die folgenden Mitgliedschaftsaktivitäten ausgeführt:

  • Ein Nutzer tritt dem Gruppenbereich bei. Dadurch wird eine Membership-Ressource erstellt und das Ereignis „Neues Mitglied“ ausgelöst.
  • Ein Nutzer wird zum Administrator eines Gruppenbereichs. Dadurch wird die Membership-Ressource für den Nutzer aktualisiert und ein aktualisiertes Mitgliedsereignis ausgelöst.
  • Ein Nutzer verlässt den Gruppenbereich. Dadurch wird die Membership-Ressource für den Nutzer gelöscht und das Ereignis „Mitglied gelöscht“ ausgelöst.

Mitgliedschaftsereignisse abonnieren

Um Ereignisse in Echtzeit zu empfangen, ruft die Chat-App die Methode subscriptions.create() der Google Workspace Events API auf, um den Gruppenbereich für alle Arten von Mitgliedschaftsereignissen zu abonnieren. Nach dem Erstellen des Abos kann die Chat-App Mitgliedschaftsereignisse empfangen.

Chat-App, die Ereignisse mit der Google Workspace Events API abonniert
Abbildung 2: Eine Chat-App empfängt Mitgliedschaftsereignisse über ein Abo mithilfe der Google Workspace Events API.

In Abbildung 2 hat die Chat-App ein aktives Abo für den Gruppenbereich. Daher empfängt die App ein Ereignis, wenn sich eine Mitgliedschaft im Gruppenbereich ändert. Die Chat-App kann dann alle Aktivitäten in Echtzeit verarbeiten oder darauf reagieren, z. B. eine private Begrüßungsnachricht an das Mitglied posten, das dem Gruppenbereich beigetreten ist.

Informationen zum Erstellen von Abos mit der Google Workspace Events API finden Sie in der Dokumentation zur Google Workspace Events API.

Letzte Mitgliedschaftsereignisse abfragen

Anstatt die Mitgliedschaftsereignisse in Echtzeit zu erhalten, kann eine Chat-App die Chat API aufrufen, um die letzten Gruppenbereichsereignisse aufzulisten, die sich auf Mitgliedschaftsaktivitäten beziehen.

Chat-App, die mit der Chat API nach Ereignissen sucht
Abbildung 3. Eine Chat-App empfängt aktuelle Mitgliedschaftsereignisse, indem sie mithilfe der Chat API nach Gruppenbereichsereignissen fragt.

In Abbildung 3 ruft eine Chat-App die Methode spaces.spaceEvents.list() der Chat API auf, nachdem alle Mitgliedschaftsaktivitäten stattgefunden haben, und filtert die Abfrage nach neuen, aktualisierten und gelöschten Mitgliedschaftsereignissen. Die Chat API gibt eine Liste von spaceEvent-Ressourcen zurück, die jede der Mitgliedschaftsänderungen repräsentieren. Die Chat-App kann dann basierend auf den letzten Aktivitäten verarbeiten oder reagieren, z. B. eine wöchentliche Nachricht mit einer Zusammenfassung der Aktivitäten der Mitglieder des Gruppenbereichs in den letzten sieben Tagen posten.

Informationen zum Abfragen von Ereignissen mit der Chat API finden Sie unter Ereignisse aus einem Google Chat-Bereich auflisten.

Beschränkungen
  • Bei Abos von Nutzern werden Ereignisse zu neuen Mitgliedern in Direktnachrichten oder unbenannten Gruppenchats (google.workspace.chat.membership.v1.created) erst ausgelöst, nachdem die erste Nachricht gepostet wurde.
  • Damit der Nutzer Mitgliedschaftsereignisse erhält, muss er ein direktes Mitglied des Gruppenbereichs sein. Wenn ein Nutzer einem Gruppenbereich indirekt über eine Google-Gruppe hinzugefügt, aktualisiert oder entfernt wurde, werden diese Mitgliedschaftsereignisse nicht an das Abo gesendet. Informationen zur Funktionsweise von Google-Gruppenmitgliedschaften finden Sie unter Google-Gruppen zu Gruppenbereichen hinzufügen.