Method: projects.locations.obtainCrawlRate

モニタリング用のオーガニック クロール率または専用クロール率の時系列データを取得します。専用クロール率が設定されていない場合、Vertex AI のオーガニック クロール率の時系列が返されます。オーガニック クロールとは、Google が独自の都合でインターネットを自動的にクロールすることを意味します。専用クロール頻度が設定されている場合、Vertex AI の専用クロール頻度の時系列が返されます。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 のクロール率です。ユーザー トリガー クロール率は、ユーザーが指定した URL やサイトマップのクロールなどの決定論的なユースケースで使用されます。
autoRefreshCrawlRate

object (CrawlRateTimeSeries)

Vertex AI の専用クロール率の時系列（専用クロールが設定されている場合の Google-CloudVertexBot のクロール率）。このクロール率は、URL の定期的な更新などのベスト エフォートのユースケースで使用されます。
userTriggeredCrawlErrorRate

object (CrawlRateTimeSeries)

ユーザーがトリガーした専用クロールの Vertex AI のエラー率の時系列。
autoRefreshCrawlErrorRate

object (CrawlRateTimeSeries)

自動更新専用クロールの Vertex AI のエラー率の時系列。

状態

レスポンスのさまざまな状態。

列挙型
STATE_UNSPECIFIED 状態は指定されていません。
SUCCEEDED 状態は成功です。
FAILED 状態は失敗です。