Method: index.inspect

Confira o status indexado ou indexável do URL fornecido. No momento, apenas o status da versão no índice do Google está disponível. não é possível testar a indexabilidade de um URL ativo.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "inspectionUrl": string,
  "siteUrl": string,
  "languageCode": string
}
Campos
inspectionUrl

string

Obrigatório. URL totalmente qualificado para inspeção. Precisa estar na propriedade especificada em "siteUrl".

siteUrl

string

Obrigatório. O URL da propriedade, conforme definido no Search Console. Observe que As propriedades de prefixo de URL precisam incluir uma marca "/" à direita. Exemplos:https://www.example.com/ para uma propriedade de prefixo de URL ou sc-domain:example.com para uma propriedade do domínio.

languageCode

string

Opcional. Um código de idioma IETF BCP-47 que representa o idioma solicitado para mensagens de problemas traduzidas, por exemplo, "pt-BR", "ou "de-CH". O valor padrão é "en-US".

Corpo da resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Resposta da inspeção do status do índice.

Representação JSON
{
  "inspectionResult": {
    object (UrlInspectionResult)
  }
}
Campos
inspectionResult

object (UrlInspectionResult)

Resultados da inspeção do URL.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.