API Reference

A API Search Console oferece os seguintes serviços:

  • Análise de pesquisa: consulte dados de tráfego do site.
  • Sitemaps: liste todos os sitemaps, solicite informações sobre um sitemap específico e envie um sitemap ao Google.
  • Sites: liste/adicione/remova propriedades da sua conta do Search Console.
  • Inspeção de URL: inspecione o status de uma página no índice do Google (equivalente à inspeção de URL no Search Console).

Search Analytics

Para saber mais sobre o recurso Search Analytics, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/webmasters/v3, a menos que especificado de outra forma
query POST  /sites/siteUrl/searchAnalytics/query

Consulte os dados de tráfego de pesquisa com filtros e parâmetros definidos por você. O método retorna zero ou mais linhas agrupadas pelas chaves (dimensões) definidas por você. Você precisa definir um período de um ou mais dias.

Quando a data é uma das dimensões, todos os dias sem dados são omitidos da lista de resultados. Para saber em quais dias os dados são exibidos, faça uma consulta sem filtros agrupados por data no período desejado.

Os resultados são classificados por contagem de cliques em ordem decrescente. Se duas linhas tiverem a mesma contagem de cliques, elas serão classificadas de forma arbitrária.

Consulte a amostra de Python para chamar esse método.

Exemplo de POST JSON: 
POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query
{
  "startDate": "2015-04-01",
  "endDate": "2015-05-01",
  "dimensions": ["country","device"]
}

Sitemaps

Para saber mais sobre o recurso Sitemaps, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/webmasters/v3, a menos que especificado de outra forma
delete DELETE  /sites/siteUrl/sitemaps/feedpath Exclui um sitemap desse site.
get GET  /sites/siteUrl/sitemaps/feedpath Recupera informações sobre um sitemap específico.
list GET  /sites/siteUrl/sitemaps Lista as sitemaps-inputs enviadas para o site ou incluídas no arquivo de índice de sitemaps (se sitemapIndex for especificado na solicitação).
enviar PUT  /sites/siteUrl/sitemaps/feedpath Envia um sitemap para um site.

Sites

Para saber mais sobre o recurso Sites, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/webmasters/v3, a menos que especificado de outra forma
adicionar PUT  /sites/siteUrl Adiciona um site ao conjunto de sites do usuário no Search Console.
delete DELETE  /sites/siteUrl Remove um site do conjunto de sites do Search Console do usuário.
get GET  /sites/siteUrl Recupera informações sobre um site específico.
list GET  /sites Lista os sites do Search Console do usuário.

Inspeção de URL

Para saber mais sobre o recurso de inspeção de URL, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URI relativo a https://searchconsole.googleapis.com/v1.
index.inspect POST /urlInspection/index:inspect

Informações sobre o URL fornecido no índice do Google.

Exemplo de POST JSON: 
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}