API Reference

A API Search Console oferece os seguintes serviços:

  • Search Analytics: consulte dados de tráfego do seu 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).

Pesquisar análises

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

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/webmasters/v3, salvo indicação em contrário
query POST  /sites/siteUrl/searchAnalytics/query

Consulte seus 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 de linha (dimensões) que você define. Você deve definir um período de um ou mais dias.

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

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 maneira arbitrária.

Consulte o exemplo do Python para chamar este método.

Exemplo de JSON POST: 
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 obter detalhes do recurso de sitemaps, consulte a página de representação de recursos.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/webmasters/v3, salvo indicação em contrário
excluir DELETE  /sites/siteUrl/sitemaps/feedpath Exclui um sitemap do site.
get GET  /sites/siteUrl/sitemaps/feedpath Recupera informações sobre um sitemap específico.
list GET  /sites/siteUrl/sitemaps Lista os sitemaps-entradas enviados para este site ou incluídos no arquivo de índice de sitemap (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 relativos a https://www.googleapis.com/webmasters/v3, salvo indicação em contrário
adicionar PUT  /sites/siteUrl Adiciona um site ao conjunto de sites do usuário no Search Console.
excluir 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 JSON POST: 
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}