Mit Terminen aus Google Chat arbeiten

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

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

Hier sind einige Beispiele für die Verwendung von Ereignissen:

  • Neue Nachrichten in einem Gruppenbereich überwachen und beantworten, z. B. nach Schlüsselwörtern oder Sätzen.
  • Senden Sie den Nutzern eine Willkommensnachricht, 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.
  • Sie können die Chataktivität verfolgen und analysieren. Sie können z. B. einen monatlichen Bericht über neue Mitglieder oder die Nachrichten senden, die die meisten Reaktionen oder Antworten erhalten.
  • Kommunikation zwischen Messaging-Plattformen Beispielsweise können Nutzer Nachrichten von Nutzern auf einer anderen Messaging-Plattform senden und empfangen, ohne Chat zu verlassen.

Funktionsweise von Ereignissen

Wenn in Google Chat etwas passiert, wird eine Google Chat API-Ressource erstellt, aktualisiert oder gelöscht. Chat verwendet Ereignisse, um der Chat-App Informationen über die Art der aufgetretenen Aktivität und die betroffene Chat API-Ressource zu senden.

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 Chat werden Ereignisse nach Typ kategorisiert. Mithilfe von Ereignistypen können Sie nur die Art von Informationen filtern und erhalten, die Sie benötigen. Außerdem können Sie ähnliche Aktivitäten auf die gleiche Weise ausführen.

Die folgende Tabelle zeigt, wie sich eine Aktivität in Chat auf eine zugehörige Chat API-Ressource auswirkt und welche Art von Ereignis Ihre Chat-App empfängt:

Aktivitäten Chat API-Ressource Ereignistyp
Ein Nutzer postet eine Nachricht in einem Chatbereich Eine Message-Ressource wird erstellt. Neue Nachricht
Ein Nutzer wird zum Administrator des 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

Termine aus Google Chat empfangen

Zum Empfangen von Ereignissen kann Ihre Chat-App eine der folgenden Aktionen ausführen:

  • Abonnieren Sie Ereignisse mit der Google Workspace Events API, um Ereignisse zu empfangen, sobald sie auftreten.
  • Fragen Sie nach aktuellen Ereignissen, indem Sie die Chat API aufrufen.

In der folgenden Tabelle werden der Unterschied und die 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ät von Nutzern im Blick behalten und neue Gruppenbereiche entdecken, die Sie überwachen können.
  • Ereignisse in regelmäßigen Abständen oder über einen Trigger verarbeiten oder darauf reagieren
  • Verpasste Ereignisse eines Abos abrufen (aufgrund eines Ausfalls oder inaktiven Abos).
API Google Workspace Events API Chat API
Ereignisquelle Gruppenbereiche und Nutzer Nur Gruppenbereiche
Unterstützte Ereignisse
  • Meldungen
  • Kanalmitgliedschaft
  • Reaktionen
  • Leerzeichen

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

Eine Liste der unterstützten Ereignistypen finden Sie in der Referenzdokumentation zur Chat API in der spaceEvents-Ressource.
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, die Ressourcendaten enthält. Einige Ereignistypen enthalten nur bestimmte Ressourcenfelder. Beispiele für Nutzlasten finden Sie in der Referenzdokumentation.

Beispiel: Termine zur Mitgliedschaft in einem Gruppenbereich abfragen oder abonnieren

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

  • Ein Nutzer tritt dem Gruppenbereich bei. Dadurch wird eine Membership-Ressource erstellt und ein neues Mitgliederereignis ausgelöst.
  • Ein Nutzer wird zu einem Administrator des Gruppenbereichs, der die Ressource Membership für den Nutzer aktualisiert und ein aktualisiertes Mitgliedsereignis auslöst.
  • Ein Nutzer verlässt den Gruppenbereich, wodurch die Ressource Membership für den Nutzer gelöscht und ein Ereignis gelöscht wird, das Mitglied gelöscht wurde.

Mitgliedschaftsereignisse abonnieren

Damit Ereignisse in Echtzeit empfangen werden, ruft die Chat-App die Google Workspace Events API-Methode subscriptions.create() auf, um den Gruppenbereich für alle Arten von Mitgliedschaftsereignissen zu abonnieren. Nachdem das Abo erstellt wurde, kann die Chat-App Mitgliedschaftsereignisse empfangen.

Chat-App, die Ereignisse über die 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 erhält die App jedes Mal ein Ereignis, wenn sich eine Mitgliedschaft im Gruppenbereich ändert. Die Chat-App kann dann alle Aktivitäten in Echtzeit verarbeiten oder in Echtzeit darauf antworten, z. B. das Posten einer privaten Willkommensnachricht an das Mitglied, 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.

Abfrage der letzten Mitgliedschaftsereignisse

Anstatt die Mitgliedschaftsereignisse sofort zu empfangen, kann eine Chat-App die Chat API aufrufen, um die letzten Gruppenbereiche aufzulisten, die sich auf die Mitgliedschaftsaktivität beziehen.

Chat-App, die Ereignisse mithilfe der Chat API abfragt
Abbildung 3. Eine Chat-App empfängt aktuelle Mitgliedschaftsereignisse, indem sie mithilfe der Chat API Gruppenbereiche abfragt.

In Abbildung 3 ruft eine Chat-App die Chat API-Methode spaces.spaceEvents.list() 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 die einzelnen Mitgliedschaftsänderungen darstellen. Die Chat-App kann dann basierend auf den letzten Aktivitäten, z. B. beim Posten einer wöchentlichen Nachricht mit einer Zusammenfassung der Mitgliedschaftsaktivitäten des Gruppenbereichs in den letzten 7 Tagen, verarbeiten oder antworten.

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.
  • Änderungen am Gruppenbereichsverlauf lösen keine aktualisierten Gruppenbereichsereignisse aus (Ereignistyp: google.workspace.chat.spaces.v1.updated).
  • Um Mitgliedschaften zu empfangen, muss der Nutzer ein direktes Mitglied des Gruppenbereichs sein. Wenn ein Nutzer über eine Google-Gruppe indirekt einem Gruppenbereich hinzugefügt, aktualisiert oder entfernt wurde, werden diese Mitgliedschaftsereignisse nicht an das Abo gesendet. Informationen zur Funktionsweise von Google-Gruppenmitgliedschaften finden Sie unter Google-Gruppe zu einem Gruppenbereich hinzufügen.