Method: users.sections.list

Chat ユーザーが利用できるセクションを一覧表示します。セクションを使用すると、会話をグループ化したり、Chat のナビゲーション パネルに表示されるスペースのリストをカスタマイズしたりできます。詳しくは、Google Chat でセクションを作成、整理するをご覧ください。

認可スコープを使用したユーザー認証が必要です。

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

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。このセクションのコレクションを所有するユーザー リソース名の親。呼び出しユーザーのリスト セクションのみをサポートします。呼び出し元ユーザーを参照するには、次のいずれかを設定します。

  • me エイリアス。例: users/me

  • Workspace メールアドレス。例: users/user@example.com

  • ユーザー ID。例: users/123456789

形式: users/{user}

クエリ パラメータ

パラメータ
pageSize

integer

省略可。返されるセクションの最大数。サービスから返される数は、この値より少ない場合があります。

指定されていない場合は、最大で 10 個のセクションが返されます。

最大値は 100 です。100 を超える値を使用すると、自動的に 100 に変更されます。

負の値は INVALID_ARGUMENT エラーを返します。
pageToken

string

省略可。前のセクションの一覧呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果になる可能性があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

セクションの一覧表示に対するレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "sections": [
    {
      object (Section)
    }
  ],
  "nextPageToken": string
}
フィールド
sections[]

object (Section)

指定したユーザーのセクション。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、承認ガイドをご覧ください。