Method: projects.locations.collections.dataStores.siteSearchEngine.fetchDomainVerificationStatus

傳回目標網站清單及其網域驗證狀態。目前只能在狀態為 BASIC_SITE_SEARCH 的資料儲存庫下呼叫這個方法。

HTTP 要求

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

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

路徑參數

參數
siteSearchEngine

string

這是必要旗標，我們會從這個網站搜尋引擎資源擷取所有網域驗證狀態。projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine。

查詢參數

參數
pageSize

integer

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

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

string

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

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

要求主體

要求主體必須為空白。

回應主體

SiteSearchEngineService.FetchDomainVerificationStatus 方法的回應訊息。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "targetSites": [
    {
      object (TargetSite)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
欄位
targetSites[]

object (TargetSite)

TargetSite 清單，內含網站驗證狀態。
nextPageToken

string

可做為 pageToken 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。
totalSize

integer

符合要求的項目總數。回覆中一律會填入這項資料。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • discoveryengine.siteSearchEngines.fetchDomainVerificationStatus

詳情請參閱 IAM 說明文件。