Method: users.sections.items.list

セクション内のアイテムを一覧表示します。

セクション アイテムにできるのはスペースのみです。詳しくは、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/*}/items

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

パスパラメータ

パラメータ
parent

string

必須。このセクション アイテムのコレクションを所有する親。セクション リソース名です。呼び出し元のユーザーのセクション アイテムの一覧表示のみをサポートします。

スペースでフィルタリングする場合は、ワイルドカード - を使用してすべてのセクションを検索します。例: users/{user}/sections/-

形式: users/{user}/sections/{section}

クエリ パラメータ

パラメータ
pageSize

integer

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

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

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

負の値を指定すると、INVALID_ARGUMENT エラーが返されます。
pageToken

string

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

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

string

省略可。クエリフィルタ。

現在、スペースによるフィルタリングのみをサポートしています。

例: space = spaces/{space}

無効なクエリは INVALID_ARGUMENT エラーで拒否されます。

リクエストの本文

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

レスポンスの本文

セクション アイテムの一覧表示のレスポンス メッセージ。

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

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

object (SectionItem)

指定したセクションのセクション アイテム。
nextPageToken

string

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

認可スコープ

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

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

詳細については、認可ガイドをご覧ください。