Method: users.sections.list

Listet die für den Chatnutzer verfügbaren Bereiche auf. Mit Bereichen können Nutzer ihre Unterhaltungen gruppieren und die Liste der in der Chat-Navigationsleiste angezeigten Bereiche anpassen. Weitere Informationen finden Sie unter Bereiche in Google Chat erstellen und organisieren.

Erfordert die Nutzerauthentifizierung mit dem Autorisierungsbereich:

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

HTTP-Anfrage

GET https://chat.googleapis.com/v1/{parent=users/*}/sections

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Das übergeordnete Element, das der Nutzerressourcenname ist, der diese Sammlung von Bereichen besitzt. Unterstützt nur das Auflisten von Bereichen für den aufrufenden Nutzer. Um auf den aufrufenden Nutzer zu verweisen, legen Sie einen der folgenden Werte fest:

  • Das Alias me. Beispiel: users/me.

  • Die Workspace-E‑Mail-Adresse. Beispiel: users/user@example.com.

  • Die Nutzer-ID. Beispiel: users/123456789.

Format: users/{user}

Suchparameter

Parameter
pageSize

integer

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

Falls nicht angegeben, werden maximal 10 Bereiche zurückgegeben.

Der Höchstwert beträgt 100. Wenn Sie einen Wert über 100 verwenden, wird er automatisch in 100 geändert.

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

string

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

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

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für das Auflisten von Bereichen.

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

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

object (Section)

Die Bereiche des angegebenen Nutzers.
nextPageToken

string

Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

Weitere Informationen finden Sie im Autorisierungsleitfaden.