Mit Terminen aus Google Chat arbeiten

Auf dieser Seite wird beschrieben, 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 Chat, z. B. eine neue Nachricht in einem Gruppenbereich. Ihre Chat-App kann Ereignisse verwenden, um zu verstehen, was passiert ist, und entsprechend reagieren.

Hier einige Beispiele für die Verwendung von Ereignissen:

  • Neue Nachrichten in einem Gruppenbereich im Blick behalten und darauf reagieren, z. B. nach Schlüsselwörtern oder ‑formulierungen suchen.
  • Senden Sie eine Willkommensnachricht an Nutzer, wenn sie dem Bereich beitreten, um die Richtlinien für den Bereich zu erläutern oder Tipps zur effektiven Nutzung der Chat-App zu geben.
  • Chat-Aktivitäten verfolgen und analysieren. So können Sie beispielsweise einen monatlichen Bericht über neue Mitglieder oder die Nachrichten mit den meisten Reaktionen oder Antworten senden.
  • Über Messaging-Plattformen hinweg kommunizieren So können Nutzer beispielsweise Nachrichten von Nutzern auf einer anderen Messaging-Plattform senden und empfangen, ohne Chat zu verlassen.

So funktionieren Ereignisse

Immer wenn etwas in Google Chat passiert, wird eine Google Chat API-Ressource erstellt, aktualisiert oder gelöscht. In Google Chat werden Ereignisse verwendet, um Informationen über die Art der Aktivität und die betroffene Google Chat API-Ressource an Ihre Chat-App 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, wodurch eine Message-Ressource erstellt wird. Chat erstellt dann ein Ereignis, das Daten zur neuen Nachricht enthält.

Chat kategorisiert Ereignisse nach Typ. Mit Ereignistypen können Sie filtern und nur die Informationen erhalten, die Sie benötigen. Außerdem können Sie ähnliche Aktivitäten auf dieselbe Weise verarbeiten.

In der folgenden Tabelle sehen Sie, 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ä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 Administrator eines Gruppenbereichs. Eine Membership-Ressource wird aktualisiert. Aktualisierte Mitgliedschaft
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 aus Google Chat empfangen

Damit Ihre Chat-App Ereignisse empfangen kann, haben Sie folgende Möglichkeiten:

  • Abonnieren Sie Ereignisse über die Google Workspace Events API, um Ereignisse zu empfangen, sobald sie eintreten.
  • 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
  • Mitgliederaktivitäten im Blick behalten und neue Gruppenbereiche entdecken, die überwacht werden sollen.
  • 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
Quelle von Ereignissen 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 Ressource spaceEvents in der Referenzdokumentation zur Chat API.
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. Beispielnutzlasten finden Sie unter Ereignisdaten. JSON-Nutzlast mit Ressourcendaten. Einige Ereignistypen enthalten nur bestimmte Ressourcenfelder. Beispiel-Nutzlasten finden Sie in der Referenzdokumentation.

Beispiel: Ereignisse zu Mitgliedschaften in einem Space abfragen oder abonnieren

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

  • Ein Nutzer tritt dem Gruppenbereich bei. Dadurch wird eine Membership-Ressource erstellt und ein Ereignis für ein neues Mitglied ausgelöst.
  • Ein Nutzer wird zum Bereichsmanager. Dadurch wird die Membership-Ressource für den Nutzer aktualisiert und ein aktualisiertes Mitgliedereignis wird ausgelöst.
  • Ein Nutzer verlässt den Bereich. Dadurch wird die Membership-Ressource für den Nutzer gelöscht und ein Ereignis zum Löschen eines Mitglieds wird ausgelöst.

Mitgliedschaftsereignisse abonnieren

Damit die Chat-App Ereignisse in Echtzeit empfangen kann, ruft sie die Methode subscriptions.create() der Google Workspace Events API 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 mit der Google Workspace Events API.

In Abbildung 2 hat die Chat-App ein aktives Abo für den Gruppenbereich. Die App erhält also ein Ereignis, wenn sich die Mitgliedschaft in dem Gruppenbereich ändert. Die Chat-App kann dann alle Aktivitäten in Echtzeit verarbeiten oder darauf reagieren, z. B. eine private Willkommensnachricht an das Mitglied senden, 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 zu empfangen, wenn sie eintreten, kann eine Chat-App die Chat API aufrufen, um die letzten Gruppenbereichsereignisse im Zusammenhang mit Mitgliedschaftsaktivitäten aufzulisten.

Chat-App, die Ereignisse über die Chat API abfragt.
Abbildung 3. Eine Chat-App empfängt aktuelle Mitgliedschaftsereignisse, indem sie mit der Chat API nach Gruppenbereichsereignissen sucht.

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 Anfrage nach neuen, aktualisierten und gelöschten Mitgliedschaftsereignissen. Die Chat API gibt eine Liste von spaceEvent-Ressourcen zurück, die die einzelnen Änderungen der Mitgliedschaft darstellen. Die Chat-App kann dann auf Grundlage der letzten Aktivität reagieren, z. B. eine wöchentliche Nachricht mit einer Zusammenfassung der Mitgliedschaftsaktivitäten im Gruppenbereich in den letzten 7 Tagen posten.

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

Beschränkungen
  • Bei Abonnements für Nutzer werden Ereignisse zu neuen Mitgliedern in Direktnachrichten oder unbenannten Gruppenchats (google.workspace.chat.membership.v1.created) erst nach dem Posten der ersten Nachricht ausgelöst.
  • Damit ein Nutzer Mitgliedschaftsereignisse empfangen kann, muss er ein direktes Mitglied des Bereichs sein. Wenn ein Nutzer indirekt über eine Google-Gruppe einem Gruppenbereich hinzugefügt, aktualisiert oder daraus 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.