Method: spaces.spaceEvents.list

Listet Ereignisse aus einem Google Chat-Bereich auf. Bei jedem Ereignis enthält die payload die neueste Version der Chat-Ressource. Wenn Sie beispielsweise Ereignisse zu neuen Mitgliedern des Gruppenbereichs auflisten, gibt der Server Membership-Ressourcen zurück, die die aktuellen Details zur Mitgliedschaft enthalten. Wenn während des angeforderten Zeitraums neue Mitglieder entfernt wurden, enthält die Ereignisnutzlast eine leere Membership-Ressource.

Erfordert eine Nutzerauthentifizierung. Damit Ereignisse aufgelistet werden können, muss der authentifizierte Nutzer Mitglied des Gruppenbereichs sein.

Ein Beispiel finden Sie unter Termine 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 Gruppenbereichereignisse. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Negative Werte geben den Fehler INVALID_ARGUMENT zurück.
pageToken

string

Ein Seitentoken, das von einem vorherigen Listenaufruf für Gruppenbereiche mit einer Liste empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen Parameter, die zum Auflisten von Gruppenbereichsereignissen bereitgestellt werden, mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe verschiedener Werte an die anderen Parameter kann zu unerwarteten Ergebnissen führen.
filter

string

Erforderlich. Ein Abfragefilter.

Sie müssen mindestens einen Ereignistyp (eventType) mit dem Operator : angeben. Mit dem Operator OR können Sie nach mehreren Ereignistypen filtern. Lassen Sie Batchereignistypen im Filter weg. Die Anfrage gibt automatisch alle zugehörigen Batch-Ereignisse zurück. Wenn Sie beispielsweise nach neuen Reaktionen filtern (google.workspace.chat.reaction.v1.created), gibt der Server auch neue Batchereignisse für neue Reaktionen 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 Beginn (startTime) und Ende (endTime) filtern:

  • startTime: Exklusiver Zeitstempel, ab dem das Auflisten von Gruppenbereichen beginnen soll. Sie können Ereignisse auflisten, die bis zu 28 Tage zurückliegen. Wenn keine Vorgabe erfolgt, werden Gruppenbereichereignisse der letzten 28 Tage aufgelistet.
  • endTime: Inklusiver Zeitstempel, bis zu dem die Gruppenbereiche aufgelistet werden. Wenn kein Wert angegeben ist, werden Ereignisse bis zum Zeitpunkt der Anfrage aufgelistet.

Verwenden Sie zum Angeben einer Start- oder Endzeit den Operator = und das Format in RFC-3339. Verwenden Sie den Operator AND, um sowohl nach startTime als auch nach endTime zu filtern.

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 Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht zum Auflisten von Gruppenbereichen.

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).
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.