Method: projects.locations.obtainCrawlRate

取得自然或專屬檢索率的時間序列資料，以供監控。如果未設定專屬檢索頻率，系統會傳回 Vertex AI 的自然檢索頻率時間序列。自然檢索是指 Google 會在方便時自動檢索網際網路。設定專屬檢索頻率後，系統會傳回 Vertex AI 的專屬檢索頻率時間序列。

HTTP 要求

POST https://discoveryengine.googleapis.com/v1alpha/{location=projects/*/locations/*}:obtainCrawlRate

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

路徑參數

參數
location

string

這是必要旗標，要執行檢索速率管理的商家檔案資源。格式：projects/{project}/locations/{location}

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "crawlRateScope": string
}
欄位
crawlRateScope

string

這是必要旗標，使用者想監控的檢索速率範圍。目前僅支援網域和主機名稱。網域名稱範例：example.com。主機名稱範例：www.example.com。請勿在網域或主機名稱中加入 /。

回應主體

CrawlRateManagementService.ObtainCrawlRate 方法的回應訊息。視是否已設定專屬檢索率而定，回應會包含有機或專屬檢索率時間序列資料，供您監控。

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

JSON 表示法 
{
  "state": enum (State),
  "error": {
    object (Status)
  },

  // Union field crawl_rate_time_series can be only one of the following:
  "organicCrawlRateTimeSeries": {
    object (OrganicCrawlRateTimeSeries)
  },
  "dedicatedCrawlRateTimeSeries": {
    object (DedicatedCrawlRateTimeSeries)
  }
  // End of list of possible types for union field crawl_rate_time_series.
}
欄位
state

enum (State)

僅供輸出。回應的狀態。
error

object (Status)

處理要求時，服務發生錯誤。
聯集欄位 crawl_rate_time_series。使用者設定專屬檢索頻率後，系統會傳回專屬檢索頻率時間序列，否則會傳回自然檢索頻率時間序列。crawl_rate_time_series 只能是下列其中一項：
organicCrawlRateTimeSeries

object (OrganicCrawlRateTimeSeries)

用於監控的歷來自然檢索率時間序列資料。
dedicatedCrawlRateTimeSeries

object (DedicatedCrawlRateTimeSeries)

用於監控的歷來專屬檢索率時間序列資料。

授權範圍

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

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

詳情請參閱Authentication Overview。

OrganicCrawlRateTimeSeries

用於監控的歷來自然檢索率時間序列資料。如果未設定專屬檢索，Google 會自動決定是否檢索使用者的網站。檢索率是指 Google 傳送至使用者網站的檢索要求 QPS。

JSON 表示法 
{
  "googleOrganicCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "vertexAiOrganicCrawlRate": {
    object (CrawlRateTimeSeries)
  }
}
欄位
googleOrganicCrawlRate

object (CrawlRateTimeSeries)

Google 的自然檢索頻率時間序列，也就是所有 Googlebot 檢索頻率的總和。如要進一步瞭解 Googlebot，請參閱 https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers。
vertexAiOrganicCrawlRate

object (CrawlRateTimeSeries)

Vertex AI 的自然檢索率時間序列，也就是未設定專屬檢索時，Google-CloudVertexBot 的檢索率。如要進一步瞭解 Google-CloudVertexBot，請參閱 https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot。

CrawlRateTimeSeries

用於監控的歷來檢索率時間序列資料。

JSON 表示法 
{
  "qpsTimeSeries": {
    object (TimeSeries)
  }
}
欄位
qpsTimeSeries

object (TimeSeries)

檢索頻率的 QPS。

DedicatedCrawlRateTimeSeries

用於監控的歷來專屬檢索率時間序列資料。設定專屬檢索後，Vertex AI 會使用專屬檢索功能檢索使用者的網站。

JSON 表示法 
{
  "userTriggeredCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "autoRefreshCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "userTriggeredCrawlErrorRate": {
    object (CrawlRateTimeSeries)
  },
  "autoRefreshCrawlErrorRate": {
    object (CrawlRateTimeSeries)
  }
}
欄位
userTriggeredCrawlRate

object (CrawlRateTimeSeries)

Vertex AI 專屬的檢索率時間序列，包括使用者觸發的檢索 (設定專屬檢索時，Google-CloudVertexBot 的檢索率)，以及使用者觸發的檢索率，適用於確定性用途，例如檢索使用者指定的網址或網站地圖。
autoRefreshCrawlRate

object (CrawlRateTimeSeries)

Vertex AI 的專屬檢索率時間序列會自動重新整理，也就是設定專屬檢索時 Google-CloudVertexBot 的檢索率，而檢索率適用於盡量達成目標的使用案例，例如定期重新整理網址。
userTriggeredCrawlErrorRate

object (CrawlRateTimeSeries)

使用者觸發專屬檢索作業的 Vertex AI 錯誤率時間序列。
autoRefreshCrawlErrorRate

object (CrawlRateTimeSeries)

Vertex AI 的錯誤率時間序列，適用於自動重新整理的專屬檢索。

狀態

回應的不同狀態。

列舉
STATE_UNSPECIFIED 未指定狀態。
SUCCEEDED 狀態為成功。
FAILED 狀態為失敗。