Method: index.inspect

查看所提供网址已编入索引或可编入索引的状态。目前,仅提供该版本在 Google 索引中的状态;您无法测试实际网址是否可编入索引。

HTTP 请求

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

网址采用 gRPC 转码语法。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "inspectionUrl": string,
  "siteUrl": string,
  "languageCode": string
}
字段
inspectionUrl

string

必需。要检查的完全限定网址。必须位于“siteUrl”中指定的属性下。

siteUrl

string

必需。Search Console 中定义的资源网址。请注意, 网址前缀资源必须以“/”标记结尾。 示例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)

网址检查结果。

授权范围

需要以下 OAuth 范围之一:

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

如需了解详情,请参阅 OAuth 2.0 概览