Method: spaces.spaceEvents.list

Listet Ereignisse aus einem Google Chat-Bereich auf. Für jedes Ereignis enthält die Nutzlast die neueste Version der Chatressource. Wenn Sie beispielsweise Ereignisse zu neuen Mitgliedern eines Gruppenbereichs auflisten, gibt der Server Membership-Ressourcen zurück, die die neuesten Details zur Mitgliedschaft enthalten. Wenn im angeforderten Zeitraum neue Mitglieder entfernt wurden, enthält die Ereignisnutzlast eine leere Membership-Ressource.

Erfordert eine Nutzerauthentifizierung. Damit der authentifizierte Nutzer Ereignisse auflisten kann, muss er Mitglied des Gruppenbereichs sein.

Ein Beispiel finden Sie im Hilfeartikel Ereignisse aus einem Google Chat-Bereich auflisten.

HTTP-Anfrage

GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Ressourcenname des Google Chat-Bereichs, in dem die Ereignisse aufgetreten sind.

Format: spaces/{space}.

Abfrageparameter

Parameter
pageSize

integer

Optional. Die maximale Anzahl der zurückgegebenen Gruppenbereichsereignisse. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Bei negativen Werten wird der Fehler INVALID_ARGUMENT zurückgegeben.
pageToken

string

Ein Seitentoken, das von einem vorherigen Aufruf von Listenbereichsereignissen empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen Parameter, die zum Auflisten von Space-Ereignissen zur Verfügung gestellt werden, mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe unterschiedlicher Werte an die anderen Parameter kann zu unerwarteten Ergebnissen führen.
filter

string

Erforderlich. Einen Abfragefilter.

Sie müssen mindestens einen Ereignistyp (eventType) mit dem Operator : angeben. Wenn Sie nach mehreren Ereignistypen filtern möchten, verwenden Sie den Operator OR. Lassen Sie Batchereignistypen im Filter aus. Die Anfrage gibt automatisch alle zugehörigen Batchereignisse zurück. Wenn Sie beispielsweise nach neuen Reaktionen filtern (google.workspace.chat.reaction.v1.created), gibt der Server auch neue Ereignisse im Batch zurück (google.workspace.chat.reaction.v1.batchCreated). Eine Liste der unterstützten Ereignistypen finden Sie in der Referenzdokumentation zu SpaceEvents.

Optional können Sie auch nach Startzeit (startTime) und Endzeit (endTime) filtern:

  • startTime: Exklusiver Zeitstempel, ab dem die Listen der Gruppenbereiche beginnen sollen. Sie können Ereignisse auflisten, die bis zu 28 Tage zurückliegen. Wenn Sie nichts angeben, werden Gruppenbereichsereignisse der letzten 28 Tage aufgeführt.
  • endTime: Inklusiver Zeitstempel, bis die Gruppenbereichsereignisse aufgeführt werden. Wenn kein Wert angegeben ist, werden Ereignisse bis zum Zeitpunkt der Anfrage aufgelistet.

Verwenden Sie den Operator „ist gleich“ = und das Format RFC-3339, um eine Start- oder Endzeit anzugeben. Wenn Sie sowohl nach startTime als auch nach endTime filtern möchten, verwenden Sie den Operator AND.

Die folgenden Abfragen sind beispielsweise gültig:

startTime="2023-08-23T19:20:33+00:00" AND
endTime="2023-08-23T19:21:54+00:00"

startTime="2023-08-23T19:20:33+00:00" AND
(eventTypes:"google.workspace.chat.space.v1.updated" OR
eventTypes:"google.workspace.chat.message.v1.created")

Die folgenden Abfragen sind ungültig:

startTime="2023-08-23T19:20:33+00:00" OR
endTime="2023-08-23T19:21:54+00:00"

eventTypes:"google.workspace.chat.space.v1.updated" AND
eventTypes:"google.workspace.chat.message.v1.created"

Ungültige Anfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht zum Auflisten von Space-Ereignissen.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "spaceEvents": [
    {
      object (SpaceEvent)
    }
  ],
  "nextPageToken": string
}
Felder
spaceEvents[]

object (SpaceEvent)

Die Ergebnisse werden in chronologischer Reihenfolge zurückgegeben (ältestes Ereignis zuerst). Hinweis: Das Feld permissionSettings wird im Gruppenbereichsobjekt für Listenanfragen nicht zurückgegeben.
nextPageToken

string

Fortsetzungs-Token zum Abrufen weiterer Ereignisse. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.