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

Mendapatkan daftar Document.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama resource cabang induk, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Gunakan default_branch sebagai ID cabang, untuk mencantumkan dokumen di cabang default.

Jika pemanggil tidak memiliki izin untuk mencantumkan Document di cabang ini, terlepas dari apakah cabang ini ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Parameter kueri

Parameter
pageSize

integer

Jumlah maksimum Document yang akan ditampilkan. Jika tidak ditentukan, nilai defaultnya adalah 100. Nilai maksimum yang diizinkan adalah 1.000. Nilai di atas 1.000 ditetapkan ke 1.000.

Jika kolom ini negatif, error INVALID_ARGUMENT akan ditampilkan.
pageToken

string

Token halaman ListDocumentsResponse.next_page_token, yang diterima dari panggilan DocumentService.ListDocuments sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk DocumentService.ListDocuments harus sesuai dengan panggilan yang memberikan token halaman. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons akan berisi instance ListDocumentsResponse.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource parent:

  • discoveryengine.documents.list

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.