Method: spaces.list

Listet Gruppenbereiche auf, in denen der Aufrufer Mitglied ist. Gruppenchats und DNs werden erst angezeigt, 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 den authentifizierten Nutzer sichtbar sind. Gruppenchats und DNs werden erst angezeigt, wenn die erste Nachricht gesendet wurde.

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 nicht angegeben, werden maximal 100 Leerzeichen zurückgegeben.

Der Maximalwert beträgt 1.000. Wenn Sie einen Wert über 1.000 angeben, wird er automatisch in 1.000 geändert.

Negative Werte geben den Fehler INVALID_ARGUMENT zurück.
pageToken

string

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

Beim Paginieren sollte der Filterwert dem Aufruf entsprechen, der das Seitentoken bereitgestellt hat. Die Übergabe eines anderen Werts kann zu unerwarteten Ergebnissen führen.
filter

string

Optional. Ein Abfragefilter.

Erfordert die Nutzerauthentifizierung.

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

Zum Filtern nach Art des Gruppenbereichs müssen Sie einen gültigen enum-Wert angeben, z. B. SPACE oder GROUP_CHAT (spaceType darf 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 Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

Bei der App-Authentifizierung wird dieses Feld ignoriert und die Abfrage gibt immer alle Leerzeichen zurück. Die Chat API validiert jedoch weiterhin die Abfragesyntax, sodass ungültige Abfragen weiterhin abgelehnt werden.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender 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. Wenn das Feld leer ist, 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.