Auf dieser Seite werden die Chat-Ereignisse beschrieben, für die sich eine Chat-App mit der Google Workspace Events API registrieren kann. Nachdem Sie entschieden haben, welche Ereignistypen Sie benötigen, erstellen Sie ein Abo, um Ereignisse von Chat zu erhalten.
Sie können nicht nur Ereignisse abonnieren, sondern auch Ereignisse abfragen, indem Sie die Google Chat API aufrufen. Wenn Sie die Chat API aufrufen, können Sie Ereignisse in regelmäßigen Abständen abrufen oder Ereignisse nachholen, die Sie aufgrund eines Ausfalls möglicherweise verpasst haben. Informationen dazu, wie Sie Chat-Ereignisse empfangen und darauf reagieren können, finden Sie in der Chat-Dokumentation unter Mit Ereignissen aus Chat arbeiten.
Unterstützte Chat-Ereignisse
Mit Google Workspace-Abos können Sie Ereignisse zu den folgenden Arten von Änderungen in Chat erhalten:
- Neue, aktualisierte oder gelöschte Nachrichten im Gruppenbereich.
- Neue oder entfernte Reaktionen auf eine Nachricht.
- Neue, aktualisierte oder entfernte Mitglieder im Gruppenbereich.
- Änderungen am Gruppenbereich den Sie abonniert haben, z. B. ein aktualisierter Name oder eine aktualisierte Beschreibung.
Ressourcen, die Sie auf Ereignisse überwachen können
Wenn Sie Ereignisse erhalten möchten, geben Sie eine Chat-Ressource an, die überwacht werden soll. Diese wird als Zielressource des Abos bezeichnet.
Die Google Workspace Events API unterstützt die folgenden Zielressourcen für Chat:
| Zielressource | Format | Einschränkungen |
|---|---|---|
| Gruppenbereich |
Dabei ist SPACE die ID im
Ressourcennamen der Chat API |
Der Chat-Nutzer oder die Chat-App, die das Abo autorisiert, muss Mitglied des Gruppenbereichs über sein Google Workspace- oder Google Konto sein. Unterstützt: |
| Alle Gruppenbereiche für einen Nutzer |
|
Das Abo erhält nur Ereignisse für die Gruppenbereiche, in denen der Nutzer über sein Google Workspace- oder Google-Konto Mitglied ist. Unterstützt nur die Nutzerauthentifizierung. |
| Nutzer |
Dabei ist USER die ID im
Ressourcennamen der Chat API |
Das Abo erhält nur Ereignisse zum Nutzer, der das Abo autorisiert hat. Ein Nutzer kann kein Abo im Namen anderer Nutzer autorisieren. Unterstützt nur die Nutzerauthentifizierung. |
Ereignistypen zum Erstellen von Abos
Wenn Sie ein Abo erstellen, geben Sie im
eventTypes[]
Feld an, welche Ereignistypen Sie erhalten möchten. Ereignistypen werden
gemäß der CloudEvents-Spezifikation formatiert, z. B.
google.workspace.APPLICATION.RESOURCE.VERSION.ACTION.
Wenn Sie beispielsweise Ereignisse zu Nutzern erhalten möchten, die einem Chat-Gruppenbereich beitreten, geben Sie den Gruppenbereich als Zielressource und den Ereignistyp als google.workspace.chat.membership.v1.created an. Wenn Sie Ereignisse zu einem bestimmten Nutzer erhalten möchten, der einem Gruppenbereich beitritt, geben Sie den Nutzer als Zielressource und den Ereignistyp als google.workspace.chat.membership.v1.created an. Weitere Informationen zur
Funktionsweise von Ereignissen finden Sie unter Struktur von Google Workspace
Ereignissen.
In der folgenden Tabelle sind die Ereignistypen aufgeführt, die für Abos für Gruppenbereiche und Abos für Nutzer unterstützt werden. Informationen zu Ausnahmen, die ein Ereignis auslösen, finden Sie unter Einschränkungen.
| Ereignistyp | Format | Ressourcendaten | ||
|---|---|---|---|---|
| Abos für Gruppenbereiche | ||||
| Eine Nachricht wird gepostet. |
|
|
||
| Eine Nachricht wird aktualisiert. |
|
|
||
| Eine Nachricht wird gelöscht. |
|
|
||
| Eine Reaktion wird erstellt. |
|
|
||
| Eine Reaktion wird gelöscht. |
|
|
||
| Ein Mitglied wird dem Gruppenbereich hinzugefügt. |
|
|
||
| Ein Mitglied wird im Gruppenbereich aktualisiert. |
|
|
||
| Ein Mitglied wird aus dem Gruppenbereich entfernt. |
|
|
||
| Der Gruppenbereich wird aktualisiert. |
|
|
||
| Der Gruppenbereich wird gelöscht. |
|
|
||
| Abos für Nutzer | ||||
| Der Nutzer wird Mitglied eines Gruppenbereichs.
Nicht alle neuen Mitglieder lösen Ereignisse aus. Weitere Informationen finden Sie unter Einschränkungen |
|
|
||
| Die Mitgliedschaft des Nutzers in einem Gruppenbereich wird aktualisiert. |
|
|
||
| Der Nutzer wird als direktes Mitglied eines Gruppenbereichs entfernt. |
|
|
||
| Der Lesestatus des Nutzers für den Gruppenbereich wird aktualisiert. ( Developer Preview) |
|
|
||
| Der Lesestatus des Nutzers für den Thread wird aktualisiert. ( Developer Preview) |
|
|
||
Batch-Ereignistypen (nur Ausgabe)
Neben den Ereignistypen, die Sie abonnieren, erhält Ihre Chat-App möglicherweise auch Batch-Ereignisse. Ein Batch-Ereignis stellt viele Ereignisse desselben Typs dar, die in kurzer Zeit auftreten. Die Nutzlast eines Batch-Ereignisses enthält eine Liste aller geänderten Ressourcen.
Wenn ein Nutzer beispielsweise gleichzeitig 20 Nutzer zu einem Gruppenbereich hinzufügt, erhält Ihre Chat-App möglicherweise ein Batch-Ereignis (google.workspace.chat.membership.v1.batchCreated). Die Ereignisnutzlast enthält eine Liste aller neuen Membership-Ressourcen, die erstellt wurden, als der Nutzer die Mitglieder dem Gruppenbereich hinzugefügt hat.
Sie erhalten ein Batch-Ereignis für jeden Ereignistyp, den Sie abonnieren. Sie müssen Batch-Ereignisse daher nicht angeben, wenn Sie ein Abo erstellen. Wenn Sie beispielsweise neue Reaktionen abonnieren (google.workspace.chat.reaction.v1.created), wird Ihre Chat-App automatisch so konfiguriert, dass sie Batch-Reaktionsereignisse (google.workspace.chat.reaction.v1.batchCreated) erhält.
In der folgenden Tabelle sind die möglichen Batch-Ereignisse für ein Abo aufgeführt:
| Batch-Ereignistyp | Format |
|---|---|
| Mehrere Nachrichten werden gepostet. |
|
| Mehrere Nachrichten werden aktualisiert. |
|
| Mehrere Nachrichten werden gelöscht. |
|
| Mehrere Reaktionen werden erstellt. |
|
| Mehrere Reaktionen werden gelöscht. |
|
| Dem abonnierten Gruppenbereich werden mehrere Mitglieder hinzugefügt oder der abonnierte Nutzer wurde mehreren Gruppenbereichen hinzugefügt. |
|
| Mehrere Mitgliedschaften werden im abonnierten Gruppenbereich oder für den abonnierten Nutzer aktualisiert. |
|
| Mehrere Mitglieder werden aus dem abonnierten Gruppenbereich entfernt oder der abonnierte Nutzer wurde aus mehreren Gruppenbereichen entfernt. |
|
| Der Gruppenbereich hat mehrere Aktualisierungen. |
|
| Mehrere Lesestatus für Gruppenbereiche werden für den abonnierten Nutzer aktualisiert. ( Developer Preview) |
|
| Mehrere Lesestatus für Threads werden für den abonnierten Nutzer aktualisiert. ( Developer Preview) |
|
Ereignisdaten
In diesem Abschnitt werden Ereignisdaten und Beispielnutzlasten für Ereignisse in Chat beschrieben.
Wenn Ihr Google Workspace-Abo ein Ereignis von
Chat erhält, enthält das
data
Feld die Nutzlast für das Ereignis. Diese Nutzlast enthält Informationen zur geänderten Google Workspace-Ressource. Wenn Sie beispielsweise Mitgliedschaftsereignisse in einem Gruppenbereich abonniert haben, enthält die Nutzlast für diese Ereignisse Informationen zur geänderten spaces.membership Ressource.
Ressourcendaten in der Ereignisnutzlast
Wenn Sie ein Abo erstellen, können Sie angeben, ob die Nutzlast Details zur Ressource oder nur den Namen der Ressource enthalten soll. Wenn Sie beispielsweise Ereignisse zu Mitgliedern in einem Chat-Gruppenbereich erhalten möchten, geben Sie an, welche Felder einer Mitgliedschaftsressource in der Ereignisnutzlast enthalten sein sollen.
In der folgenden Tabelle finden Sie Beispiele für JSON-Nutzlasten für ein Abo für den Chat-Gruppenbereich spaces/AAAABBBBBB. Für jedes Ereignis, das das Abo erhält, wird die Nutzlast im Feld data des Ereignisses angezeigt:
| Beispiel | Ereignistyp | JSON-Nutzlast |
|---|---|---|
Ein Nutzer postet eine Nachricht im Gruppenbereich, die „Hallo Welt“ lautet. |
|
Mit Ressourcendaten:
{
"message":
{
"name": "spaces/Ohne Ressourcendaten:
{
"message":
{
"name": "spaces/ |
| Ein Nutzer wird zum Administrator des Gruppenbereichs. |
|
Mit Ressourcendaten:
{
"membership":
{
"name": "spaces/Ohne Ressourcendaten:
{
"membership":
{
"name": "spaces/ |
| Ein Nutzer aktualisiert die Beschreibung des Gruppenbereichs zu „Vertriebsteam für Cymbal Labs“. | google.workspace.chat.space.v1.updated |
Mit Ressourcendaten:
{
"space":
{
"name": "spaces/Ohne Ressourcendaten:
{
"space":
{
"name": "spaces/ |
| Dem Gruppenbereich wurden gleichzeitig zwei Chat-Nutzer hinzugefügt. | google.workspace.chat.membership.v1.batchCreated |
Mit Ressourcendaten:
{
"memberships": [
{
"membership": {
"name": "spaces/Ohne Ressourcendaten:
{
"memberships": [
{
"membership": {
"name": "spaces/ |
| Ein Nutzer reagiert mit dem Emoji 😊 auf eine Nachricht. | google.workspace.chat.reaction.v1.created |
Mit Ressourcendaten:
{
"reaction":
{
"name": "spaces/Ohne Ressourcendaten:
{
"reaction":
{
"name": "spaces/ |
| Nutzer reagieren mit den Emojis 😊 und 😸 auf eine Nachricht. | google.workspace.chat.reaction.v1.batchCreated |
Mit Ressourcendaten:
{
"reactions": [
{
"reaction": {
"name": "spaces/Ohne Ressourcendaten:
{
"reactions": [
{
"reaction": {
"name": "spaces/ |
| Ein Nutzer besucht einen ungelesenen Gruppenbereich, wodurch der Lesestatus für den Gruppenbereich aktualisiert wird. ( Developer Preview) | google.workspace.chat.spaceReadState.v1.updated |
Mit Ressourcendaten:
{
"spaceReadState": {
"name": "users/Ohne Ressourcendaten:
{
"spaceReadState": {
"name": "users/ |
| Ein Nutzer liest eine Nachricht in einem Thread, wodurch der Lesestatus für den Thread aktualisiert wird. ( Developer Preview) | google.workspace.chat.threadReadState.v1.updated |
Mit Ressourcendaten:
{
"threadReadState": {
"name": "users/Ohne Ressourcendaten:
{
"threadReadState": {
"name": "users/ |
Einschränkungen
-
Bei Abos für Nutzer 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 Mitgliedschaftsereignisse empfangen werden können, muss der Nutzer oder die Chat-App direkt Mitglied des Gruppenbereichs sein. Wenn sie einem Gruppenbereich indirekt über eine Google-Gruppe hinzugefügt, aktualisiert oder entfernt wurden, erhält das Abo diese Mitgliedschaftsereignisse nicht. Informationen zur Funktionsweise von Google Groups-Mitgliedschaften finden Sie unter Google-Gruppe zu einem Gruppenbereich hinzufügen.
Weitere Informationen
- Struktur von Google Workspace-Ereignissen
- OAuth-Bereiche auswählen
- Abo erstellen, um Chat-Ereignisse zu erhalten