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

取得 Document 清單。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

這是必要旗標，父項分支資源名稱，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}。使用 default_branch 做為分支 ID，列出預設分支下的文件。

如果呼叫者沒有權限列出這個分支下的 Document，無論這個分支是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

查詢參數

參數
pageSize

integer

要傳回的 Document 數量上限。如未指定，則預設為 100。允許的最大值為 1000。如果值超過 1000，系統會設為 1000。

如果這個欄位為負數，系統會傳回 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 說明文件。