Method: index.inspect

指定した URL のインデックス登録済み（インデックス登録可能）ステータスを表示します。現時点では、Google インデックスに登録されているバージョンのステータスのみが利用可能です。公開 URL のインデックス登録可能性をテストすることはできません。

HTTP リクエスト

POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect

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

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "inspectionUrl": string,
  "siteUrl": string,
  "languageCode": string
}
フィールド
inspectionUrl

string

必須。検査する完全修飾 URL。siteUrl で指定されたプロパティ内に存在する必要があります。
siteUrl

string

必須。Search Console で定義されているプロパティの URL。URL プレフィックス プロパティには末尾に「/」記号を含める必要があります。 例: https://www.example.com/（URL プレフィックス プロパティ）、sc-domain:example.com（ドメイン プロパティ）。
languageCode

string

（省略可）問題に関するメッセージの翻訳でリクエストされた言語を表す IETF BCP-47 言語コード（「en-US」、「de-CH」など）。デフォルト値は「en-US」です。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

Index-Status 検査レスポンス。

JSON 表現 
{
  "inspectionResult": {
    object (UrlInspectionResult)
  }
}
フィールド
inspectionResult

object (UrlInspectionResult)

URL 検査結果。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/webmasters
  • https://www.googleapis.com/auth/webmasters.readonly

詳細については、OAuth 2.0 の概要をご覧ください。