Method: projects.locations.dataStores.siteSearchEngine.targetSites.list

取得 TargetSite 清單。

HTTP 要求

GET https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/targetSites

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

路徑參數

參數
parent

string

這是必要旗標，父項網站搜尋引擎資源名稱，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine。

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

查詢參數

參數
pageSize

integer

要求的頁面大小。伺服器傳回的項目數量可能會少於要求數量。如未指定，伺服器會挑選適當的預設值。許可的最大值為 1000；超出的數值將一律指定為 1000。

如果這個欄位為負數，系統會傳回 INVALID_ARGUMENT 錯誤。
pageToken

string

屬於接收自前一個 targetSites.list 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時，提供至 targetSites.list 的所有其他參數須與提供網頁權杖的呼叫相符。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體會包含 ListTargetSitesResponse 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • discoveryengine.targetSites.list

詳情請參閱 IAM 說明文件。