Method: projects.locations.collections.list

Collection のリストを取得します。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*}/collections

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

パスパラメータ

パラメータ
parent

string

必須。親データストアのリソース名（projects/{project}/locations/{location} 形式）。

クエリ パラメータ

パラメータ
pageSize

integer

返す Collection の最大数。サービスから返される数は、この値より少ない場合があります。

指定されていない場合、最大で 100 個の Collection が返されます。

最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。
pageToken

string

前回の CollectionService.ListCollections 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、CollectionService.ListCollections に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。
filter

string

関連付けられたデータ コネクタのデータソースで、返されたコレクションをフィルタします。例: filter = 'dataSource:jira confluence'。フィルタが空の場合、プロジェクトとロケーションにあるすべてのコレクションが返されます。

リクエストの本文

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

レスポンスの本文

CollectionService.ListCollections メソッドに対するレスポンス メッセージ。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

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

object (Collection)

Collection。
nextPageToken

string

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

認可スコープ

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • discoveryengine.collections.list

詳細については、IAM のドキュメントをご覧ください。