Method: spaces.spaceEvents.list

Listet Ereignisse aus einem Google Chat-Bereich auf. Für jedes Ereignis enthält die Nutzlast die aktuelle Version der Chat-Ressource. Wenn Sie beispielsweise Ereignisse zu neuen Projektbereichsmitgliedern auflisten, gibt der Server Membership-Ressourcen mit den neuesten Mitgliedschaftsdetails zurück. Wenn im angeforderten Zeitraum neue Mitglieder entfernt wurden, enthält die Ereignis-Nutzlast eine leere Membership-Ressource.

Unterstützt die folgenden Arten der Authentifizierung mit einem Autorisierungsbereich, der zum Lesen der angeforderten Daten geeignet ist:

  • App-Authentifizierung mit Administratorgenehmigung in der Developer Preview mit einem der folgenden Autorisierungsbereiche:

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

  • Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

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

Um Ereignisse aufzulisten, muss der authentifizierte Aufrufer Mitglied des Gruppenbereichs sein.

Ein Beispiel finden Sie unter Ereignisse aus einem Google Chat-Gruppenbereich 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. Der 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 Space-Ereignisse. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Bei negativen Werten wird ein INVALID_ARGUMENT-Fehler zurückgegeben.
pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen Aufruf von „list space events“ empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für die Auflistung von Space-Ereignissen bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie für die anderen Parameter unterschiedliche Werte übergeben, kann das zu unerwarteten Ergebnissen führen.
filter

string

Erforderlich. Ein Abfragefilter.

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

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

  • startTime: Exklusiver Zeitstempel, ab dem Space-Ereignisse aufgeführt werden sollen. Sie können Ereignisse auflisten, die bis zu 28 Tage zurückliegen. Wenn nicht angegeben, werden Ereignisse aus den letzten 28 Tagen aufgeführt.
  • endTime: Inklusiver Zeitstempel, bis zu dem Space-Ereignisse aufgeführt werden. Wenn nichts angegeben ist, werden Ereignisse bis zum Zeitpunkt der Anfrage aufgeführt.

Wenn Sie eine Start- oder Endzeit angeben möchten, verwenden Sie den Operator „Gleich“ = und das RFC-3339-Format. Wenn Sie nach startTime und 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 Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht zum Auflisten von Gruppenbereichsereignissen.

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 Space-Objekt für Listenanfragen nicht zurückgegeben.
nextPageToken

string

Fortsetzungstoken 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.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • 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 Autorisierungsleitfaden.