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 プレフィックス プロパティには末尾の / マークを含める必要があります。 例: URL プレフィックス プロパティの場合は https://www.example.com/、ドメイン プロパティの場合は 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 の概要をご覧ください。