Method: projects.locations.collections.dataStores.branches.documents.list

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

必須。親ブランチのリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch} など）。ブランチ ID として default_branch を使用して、デフォルト ブランチでドキュメントを一覧表示します。

呼び出し元にこのブランチの Document を一覧表示する権限がない場合、このブランチが存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。

クエリ パラメータ

パラメータ
pageSize

integer

返す Document の最大数。指定しない場合、デフォルトは 100 です。最大値は 1,000 です。1,000 を超える値は 1,000 に設定されます。

このフィールドが負の数の場合、INVALID_ARGUMENT エラーが返されます。
pageToken

string

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

ページ分割を行う場合、DocumentService.ListDocuments に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。

リクエストの本文

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

レスポンスの本文

成功した場合、レスポンスの本文には ListDocumentsResponse のインスタンスが含まれます。

認可スコープ

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

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

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

IAM 権限

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

  • discoveryengine.documents.list

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