Method: users.sections.list

Listet die Abschnitte auf, die für den Chat-Nutzer verfügbar sind. Mit Bereichen können Nutzer ihre Unterhaltungen gruppieren und die Liste der Bereiche anpassen, die im Navigationsbereich von Google Chat angezeigt werden. Weitere Informationen finden Sie unter Bereiche in Google Chat erstellen und organisieren.

Erfordert 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 Abschnitten besitzt. Es werden nur Listenabschnitte für den anrufenden Nutzer unterstützt. Legen Sie einen der folgenden Werte fest, um auf den anrufenden Nutzer zu verweisen:

  • Der Alias me. Beispiel: users/me.

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

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

Format: users/{user}

Suchparameter

Parameter
pageSize

integer

Optional. Die maximale Anzahl der zurückzugebenden Abschnitte. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

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

Der Höchstwert ist 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 zum Auflisten von Abschnitten 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 das zu unerwarteten Ergebnissen führen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für die Auflistung von Abschnitten.

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

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

object (Section)

Die Abschnitte 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.