Google Chat-Ereignisse abonnieren

Auf dieser Seite werden die Google Chat-Ereignisse beschrieben, die von einer Google Chat-App mit der Google Workspace Events API abonniert werden können.

Weitere Informationen zum Entwickeln der Google Chat-App finden Sie in der Übersicht zur Google Chat API.

Unterstützte Chat-Zielressourcen

Die Google Workspace Events API unterstützt Abos für:

  • Gruppenbereiche, dargestellt als space-Ressourcen
  • Nutzer, dargestellt als user-Ressourcen der Cloud Identity API

Unterstützte Chatereignisse

Mit Google Workspace-Abos können Sie Ereignisse zu den folgenden Arten von Änderungen in Google Chat erhalten:

  • Neue oder aktualisierte Nachrichten im Gruppenbereich.
  • Neue oder entfernte Reaktionen auf eine Nachricht.
  • Neue, aktualisierte oder entfernte Mitglieder im Gruppenbereich
  • Änderungen an dem von Ihnen abonnierten Gruppenbereich, z. B. ein aktualisierter Name oder eine aktualisierte Beschreibung des Gruppenbereichs

Ereignistypen zum Erstellen von Abos

Beim Erstellen eines Abos kannst du im Feld eventTypes[] angeben, welche Arten von Ereignissen du erhalten möchtest. Ereignistypen werden gemäß der CloudEvents-Spezifikation formatiert, z. B. google.workspace.APPLICATION.RESOURCE.VERSION.ACTION.

Wenn Sie beispielsweise Ereignisse über Nutzer erhalten möchten, die einem Chatbereich beitreten, geben Sie den Bereich als Zielressource und den Ereignistyp google.workspace.chat.membership.v1.created an. Wenn Sie Ereignisse zu einem bestimmten Nutzer empfangen möchten, der einen beliebigen Bereich einnimmt, geben Sie den Nutzer als Zielressource und den Ereignistyp 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 sehen Sie, welche Ereignistypen für Abos von Gruppenbereichen und Abos von Nutzern unterstützt werden:

Ereignistyp Beschreibung Ressourcendaten
Abos für Gruppenbereiche  

google.workspace.chat.message.v1.created

Eine neue Nachricht wird gepostet.

space.message

google.workspace.chat.message.v1.updated

Eine Nachricht wird aktualisiert.

space.message

google.workspace.chat.reaction.v1.created

Eine Reaktion wird erstellt.

space.message.reaction

google.workspace.chat.reaction.v1.deleted

Eine Reaktion wird gelöscht.

space.message.reaction

google.workspace.chat.membership.v1.created

In diesem Gruppenbereich wurde ein Mitglied erstellt.

space.membership

google.workspace.chat.membership.v1.updated

In diesem Gruppenbereich wurde ein Mitglied aktualisiert.

space.membership

google.workspace.chat.membership.v1.deleted

Ein Mitglied wurde aus diesem Gruppenbereich entfernt.

space.membership

google.workspace.chat.space.v1.updated

Der Gruppenbereich wird aktualisiert.

space

google.workspace.chat.space.v1.deleted

Der Gruppenbereich wird gelöscht.

space

Abos für Nutzer  

google.workspace.chat.membership.v1.created

Der Nutzer wird Mitglied eines Gruppenbereichs.

space.membership

google.workspace.chat.membership.v1.updated

Die Mitgliedschaft des Nutzers bei einem Gruppenbereich wird aktualisiert.

space.membership

google.workspace.chat.membership.v1.deleted

Der Nutzer wird als Mitglied eines Gruppenbereichs entfernt.

space.membership

Nur Ausgabeereignistypen

Wenn Sie den Ereignistyp google.workspace.APPLICATION.RESOURCE.VERSION.ACTION abonnieren, wird das Abo automatisch so eingerichtet, dass es auch Batchversionen des Ereignistyps erhält. Wenn Sie beispielsweise google.workspace.chat.membership.v1.created abonnieren, erhalten Sie auch Ereignisse für google.workspace.chat.membership.v1.batchCreated.

In der folgenden Tabelle sehen Sie, welche Ereignistypen nur für Abos von Gruppenbereichen und Nutzern ausgegeben werden:

Ereignistyp Beschreibung Ressourcendaten

google.workspace.chat.message.v1.batchCreated

Es werden mehrere Nachrichten gleichzeitig gepostet.

Liste von spaces.messages

google.workspace.chat.message.v1.batchUpdated

Mehrere Nachrichten werden gleichzeitig aktualisiert.

Liste von spaces.messages

google.workspace.chat.reaction.v1.batchCreated

Mehrere Reaktionen werden gleichzeitig erstellt.

Liste von spaces.messages.reactions

google.workspace.chat.reaction.v1.batchDeleted

Mehrere Reaktionen werden gleichzeitig gelöscht.

Liste von spaces.messages.reactions

google.workspace.chat.membership.v1.batchCreated

  • Wenn target_resource ein Gruppenbereich ist, werden im Gruppenbereich mehrere Mitglieder erstellt.
  • Wenn target_resource ein Nutzer ist, wird der Nutzer Mitglied mehrerer Gruppenbereiche.

Liste von spaces.memberships

google.workspace.chat.membership.v1.batchUpdated

  • Wenn target_resource ein Gruppenbereich ist, werden mehrere Mitglieder im Gruppenbereich aktualisiert.
  • Wenn target_resource ein Nutzer ist: Für die Mitgliedschaften des Nutzers in Gruppenbereichen gibt es mehrere Aktualisierungen.

Liste von spaces.memberships

google.workspace.chat.membership.v1.batchDeleted

  • Wenn target_resource ein Gruppenbereich ist, werden mehrere Mitglieder aus dem Gruppenbereich entfernt.
  • Wenn target_resource ein Nutzer ist, wird der Nutzer aus mehreren Gruppenbereichen als Mitglied entfernt.

Liste von spaces.memberships

google.workspace.chat.space.v1.batchUpdated

Der Gruppenbereich hat mehrere Aktualisierungen.

Liste von spaces

Ereignisdaten

In diesem Abschnitt werden Ereignisdaten und Beispielnutzlasten für Ereignisse in Google Chat beschrieben.

Wenn Ihr Google Workspace-Abo ein Ereignis von Chat empfängt, enthält das Feld data die Nutzlast für das Ereignis. Diese Nutzlast enthält Informationen über die Google Workspace-Ressource, die sich geändert hat. Wenn Sie beispielsweise Mitgliedschaftsereignisse in einem Gruppenbereich abonniert haben, enthält die Nutzlast für diese Ereignisse Informationen zur Ressource spaces.membership, die sich geändert hat.

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 Chatbereich erhalten möchten, können Sie angeben, welche Felder einer Mitgliedschaftsressource in der Ereignisnutzlast empfangen werden sollen.

Die folgende Tabelle enthält Beispiele für JSON-Nutzlasten für ein Abo des Chatbereichs spaces/AAAABBBBBB. Für jedes Ereignis, das das Abo empfängt, wird die Nutzlast im Feld data des Ereignisses angezeigt:

Beispiel Ereignistyp JSON-Nutzlast

Ein Nutzer postet eine Nachricht mit dem Text „Hallo Welt“.

google.workspace.chat.message.v1.created

Enthält Ressourcendaten
{
    "message":
    {
        "name": "spaces/AAAABBBBBB/messages/CCCCCCCCC.DDDDDDDDD",
        "sender":
        {
            "name": "users/1234567890987654321",
            "type": "HUMAN"
        },
        "createTime": "2023-09-07T21:37:36.260127Z",
        "text": "Hello world",
        "thread":
        {
            "name": "spaces/AAAABBBBBB/threads/EEEEEEEEEEEE"
        },
        "space":
        {
            "name": "spaces/AAAABBBBBB"
        },
        "argumentText": "Hello world"
    }
}
      
Schließt Ressourcendaten aus
{
    "message":
    {
        "name": "spaces/AAAABBBBBB/messages/CCCCCCCCC.DDDDDDDDD"
    }
}
      
Ein Nutzer wird zum Administrator des Gruppenbereichs.

google.workspace.chat.membership.v1.updated

Enthält Ressourcendaten
{
    "membership":
    {
        "name": "spaces/AAAABBBBBB/members/1234567890987654321",
        "state": "JOINED",
        "member":
        {
            "name": "users/1234567890987654321",
            "type": "HUMAN"
        },
        "createTime": "1970-01-01T00:00:00Z",
        "role": "ROLE_MANAGER"
    }
}
      
Schließt Ressourcendaten aus
{
    "membership":
    {
        "name": "spaces/AAAABBBBBB/members/1234567890987654321"
    }
}
      
Ein Nutzer aktualisiert die Beschreibung des Gruppenbereichs in „Vertriebsteam für Cymbal Labs“. google.workspace.chat.space.v1.updated
Enthält Ressourcendaten
{
    "space":
    {
        "name": "spaces/AAAABBBBBB",
        "displayName": "Cymbal Sales",
        "spaceThreadingState": "THREADED_MESSAGES",
        "spaceType": "SPACE",
        "spaceDetails":
        {
            "description": "Sales team for Cymbal Labs."
        },
        "spaceHistoryState": "HISTORY_ON"
    }
}
      
Schließt Ressourcendaten aus
{
    "space":
    {
        "name": "spaces/AAAABBBBBB"
    }
}
      
Dem Gruppenbereich wurden zwei Chat-Nutzer gleichzeitig hinzugefügt. google.workspace.chat.membership.v1.batchCreated
Enthält Ressourcendaten
{
    "memberships": [
        {
          "membership": {
            "name": "spaces/AAAABBBBBB/members/1234567890987654321",
            "state": "JOINED",
            "member":
            {
                "name": "users/1234567890987654321",
                "type": "HUMAN"
            },
            "createTime": "1970-01-01T00:00:00Z",
            "role": "ROLE_MEMBER"
          }
        },
        {
          "membership": {
            "name": "spaces/AAAABBBBBB/members/987654321234567890",
            "state": "JOINED",
            "member":
            {
                "name": "users/987654321234567890",
                "type": "HUMAN"
            },
            "createTime": "1970-01-01T00:00:00Z",
            "role": "ROLE_MEMBER"
          }
        }
    ]
}
      
Schließt Ressourcendaten aus
{
    "memberships": [
        {
          "membership": {
            "name": "spaces/AAAABBBBBB/members/1234567890987654321"
          }
        },
        {
          "membership": {
            "name": "spaces/AAAABBBBBB/members/98765432123456789019"
          }
        }
    ]
}
      
Ein Nutzer reagiert auf eine Nachricht mit dem Emoji 😊. google.workspace.chat.reaction.v1.created
Enthält Ressourcendaten
{
    "reaction":
    {
        "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222",
        "user":
        {
            "name": "users/1234567890987654321",
            "type": "HUMAN"
        },
        "emoji":
        {
            "unicode": "😊"
        }
    }
}
      
Lässt Ressourcendaten aus
{
    "reaction":
    {
        "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222"
    }
}
      
Nutzer reagieren auf eine Nachricht mit den 😊-Emojis und DAGs-Emojis. google.workspace.chat.reaction.v1.batchCreated
Enthält Ressourcendaten
{
    "reactions": [
        {
          "reaction": {
            "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222",
            "user":
            {
                "name": "users/1234567890987654321",
                "type": "HUMAN"
            },
            "emoji":
            {
                "unicode": "😊"
            }
          }
        },
        {
          "reaction": {
            "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/3333333333333333.444444444444444",
            "user":
            {
                "name": "users/98765431234564321",
                "type": "HUMAN"
            },
            "emoji":
            {
                "unicode": "😸"
            }
          }
        }
    ]
}
      
Lässt Ressourcendaten aus
{
    "reactions": [
      {
        "reaction": {
            "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222"
        },
        "reaction": {
            "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/3333333333333333.444444444444444",
        }
      }
    ]
}