Method: spaces.list

Listet Gruppenbereiche auf, in denen der Aufrufer Mitglied ist. Gruppenchats und DNs werden erst aufgeführt, wenn die erste Nachricht gesendet wurde. Ein Beispiel finden Sie unter Gruppenbereiche auflisten.

Erfordert eine Authentifizierung. Unterstützt die App-Authentifizierung und die Nutzerauthentifizierung.

Listet Gruppenbereiche auf, die für den Aufrufer oder authentifizierten Nutzer sichtbar sind. Gruppenchats und DNs werden erst aufgeführt, wenn die erste Nachricht gesendet wurde.

Wenn Sie alle benannten Gruppenbereiche nach Google Workspace-Organisation auflisten möchten, verwenden Sie stattdessen die Methode spaces.search() mit Workspace-Administratorberechtigungen.

HTTP-Anfrage

GET https://chat.googleapis.com/v1/spaces

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
pageSize

integer

Optional. Die maximale Anzahl von Leerzeichen, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Wenn keine Angabe gemacht wird, werden maximal 100 Leerzeichen zurückgegeben.

Der Höchstwert beträgt 1.000. Wenn Sie einen höheren Wert als 1.000 verwenden, wird er automatisch in 1.000 geändert.

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

string

Optional. Seitentoken, das von einem vorherigen Aufruf einer Gruppenbereichsliste erhalten wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen.

Beim Paginieren sollte der Filterwert mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Das Übergeben eines anderen Werts kann zu unerwarteten Ergebnissen führen.
filter

string

Optional. Einen Abfragefilter.

Sie können Gruppenbereiche nach dem Typ des Gruppenbereichs filtern (spaceType).

Zum Filtern nach Gruppenbereichstyp müssen Sie einen gültigen ENUM-Wert wie SPACE oder GROUP_CHAT angeben (spaceType kann nicht SPACE_TYPE_UNSPECIFIED sein). Verwenden Sie den Operator OR, um mehrere Gruppenbereichstypen abzufragen.

Die folgenden Abfragen sind beispielsweise gültig:

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

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

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Die Antwort auf eine Anfrage zum Auflisten von Gruppenbereichen.

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

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

object (Space)

Liste der Gruppenbereiche auf der angeforderten (oder ersten) Seite.
nextPageToken

string

Sie können ein Token als pageToken senden, um die nächste Ergebnisseite abzurufen. Ist das Feld leer, 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.bot

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.