Conheça a nova API URL Inspection do Search Console

Segunda-feira, 31 de janeiro de 2022

Hoje lançamos a nova API URL Inspection do Google Search Console, que oferece acesso programático aos dados no nível do URL das propriedades que você gerencia nesse serviço.

As APIs do Search Console são uma maneira de acessar os dados fora da plataforma, por produtos e aplicativos externos. Os desenvolvedores e as ferramentas de SEO já usam as APIs para criar soluções personalizadas que permitem ver, adicionar ou remover propriedades e sitemaps, além de realizar consultas avançadas nos dados de desempenho da Pesquisa.

A nova API URL Inspection é uma ferramenta para a depuração e otimização das páginas pelos desenvolvedores. É possível solicitar os dados do Search Console sobre a versão indexada de um URL. A API retornará as informações atualmente disponíveis na Ferramenta de inspeção de URL.

Como usar a nova API

Para saber como usar a nova API, consulte a documentação para desenvolvedores. Os parâmetros de solicitação incluem o URL que você quer inspecionar e o URL da propriedade, conforme definido no Search Console.

A resposta inclui os resultados da análise com as informações do Search Console, incluindo status de indexação, AMP, pesquisas aprimoradas e usabilidade em dispositivos móveis. Para mais detalhes, leia a lista de parâmetros e a explicação sobre os resultados do URL indexado.

Após a chamada da API, você receberá uma resposta com todos os resultados relevantes ou, se a solicitação falhar, uma mensagem de erro. Se faltar um resultado específico na resposta, isso significa que a análise não estava disponível para o URL inspecionado. Veja um exemplo de resposta da API.

  {
  "inspectionResult": {
    "inspectionResultLink": "https://search.google.com/search-console/inspect?resource_id=https://developers.google.com/search/&id=odaUL5Dqq3q8n0EicQzawg&utm_medium=link&utm_source=api",
    "indexStatusResult": {
      "verdict": "PASS",
      "coverageState": "Indexed, not submitted in sitemap",
      "robotsTxtState": "ALLOWED",
      "indexingState": "INDEXING_ALLOWED",
      "lastCrawlTime": "2022-01-31T08:39:51Z",
      "pageFetchState": "SUCCESSFUL",
      "googleCanonical": "https://developers.google.com/search/help/site-appearance-faq",
      "userCanonical": "https://developers.google.com/search/help/site-appearance-faq",
      "referringUrls": [
        "https://developers.google.com/search/updates",
        "https://developers.google.com/search/help/crawling-index-faq"
      ],
      "crawledAs": "MOBILE"
    },
    "mobileUsabilityResult": {
      "verdict": "PASS"
    },
    "richResultsResult": {
      "verdict": "PASS",
      "detectedItems": [
        {
          "richResultType": "Breadcrumbs",
          "items": [
            {
              "name": "Unnamed item"
            }
          ]
        },
        {
          "richResultType": "FAQ",
          "items": [
            {
              "name": "Unnamed item"
            }
          ]
        }
      ]
    }
  }
}

Possíveis casos de uso

Durante o desenvolvimento da nova API, consultamos vários SEOs e editores sobre como eles usariam a API para criar soluções com esses dados. Veja alguns casos de uso que se destacam:

  • As agências e ferramentas de SEO podem oferecer monitoramento contínuo de páginas importantes e opções de depuração de uma única página. Por exemplo, a verificação de diferenças entre as versões canônicas declaradas pelo usuário e selecionadas pelo Google ou a depuração de problemas de dados estruturados em um grupo de páginas.
  • Os desenvolvedores de CMS (sistemas de gerenciamento de conteúdo) e plug-ins podem adicionar insights no nível da página ou do modelo e fazer verificações contínuas das páginas. Por exemplo, o monitoramento das mudanças ao longo do tempo em páginas importantes é usado para diagnosticar problemas e priorizar correções.

Limites de uso

Veja uma descrição mais detalhada dos limites de uso das APIs do Search Console na documentação para desenvolvedores. A cota da API URL Inspection, especificamente, é aplicada de acordo com a propriedade do site do Search Console (chamadas que consultam o mesmo site):

  • 2 mil consultas por dia
  • 600 consultas por minuto

Feedback

Acreditamos que a nova API trará oportunidades ao ecossistema para a inovação com os dados da Pesquisa Google. Estamos sempre animados para ver as soluções criadas pelos desenvolvedores e analistas de SEO com base nas APIs do Search Console.

Se você tiver dúvidas ou quiser enviar feedback, entre em contato pelo Twitter ou poste uma pergunta na comunidade da Central da Pesquisa.