Atualizações da API do Search Console

Quarta-feira, 9 de dezembro de 2020

Há alguns meses, anunciamos um upgrade na infraestrutura da API para melhorar o desempenho da API Search Console conforme o aumento da demanda. Hoje estamos felizes em anunciar que mais algumas atualizações estão chegando:

  • Adição de um filtro de dados e notícias recentes na API Search Console
  • Compatibilidade com a propriedade do domínio na API Sitemaps
  • Diretrizes sobre como migrar o documento de descoberta

Se você faz suas próprias chamadas à API, continue lendo.

Filtro de dados e notícias recentes na API Search Console

O Relatório de desempenho já é compatível com dados novos de menos de um dia. Agora é possível acessar esses dados pela API transmitindo o parâmetro de solicitação dataState com o valor definido como all. Os dados que você receber para esse valor também incluirão dados recentes que ainda não são finais. Se você quiser ver somente os dados finais, poderá transmitir esse parâmetro com o valor definido como final ou não transmiti-lo, e você receberá somente dados finais por padrão.

Há alguns meses, adicionamos a guia Notícias no filtro da Pesquisa do Relatório de desempenho. Agora, essas informações também estão disponíveis na API e você pode acessá-las definindo o valor do parâmetro searchType na solicitação para news.

Compatibilidade com a propriedade do domínio na API Sitemaps

A API Sitemaps agora é compatível com as propriedades do domínio, assim como outras APIs do Search Console. É possível consultar, adicionar e excluir seus sitemaps nas propriedades do domínio. Por exemplo:

GET https://www.googleapis.com/webmasters/v3/sites/sc-domain:example.com/sitemaps

Migração de documento de descoberta

Removeremos a compatibilidade com o documento de descoberta da API Webmasters. Se você estiver consultando a API Search Console com uma biblioteca de API externa ou consultando o documento de descoberta da API Webmasters diretamente, será necessário atualizar as chamadas de API para incluir as modificações a seguir.

Mudanças na biblioteca de APIs

Para atualizações sobre as mudanças na biblioteca de APIs, consulte os guias de início rápido do Java e Python para conferir o uso atualizado das APIs.

Java

Para todas as importações relacionadas a Webmasters, mude o pacote webmasters para searchconsole.v1 e o nome do serviço, Webmasters, para SearchConsole. Exemplos:

  • Como importar o serviço da API:

    import com.google.api.services.webmasters.Webmasters;

    import com.google.api.services.searchconsole.v1.SearchConsole;

  • Como importar um objeto de resposta:

    import com.google.api.services.webmasters.model.WmxSite;

    import com.google.api.services.searchconsole.v1.model.WmxSite;

Observe que, além do objeto de serviço, outros objetos de API são exatamente os mesmos de antes, somente o pacote foi alterado.

Python

Ao criar o objeto de serviço Webmasters, faça a seguinte modificação:

webmasters_service = build('webmasters', 'v3', http=http)

webmasters_service = build('searchconsole', 'v1', http=http)

Não há mudança no comportamento dos objetos.

Consulta direta do documento de descoberta

As mudanças na consulta de documentos de descoberta incluem o seguinte:

  • Alteração no URL

    https://www.googleapis.com/discovery/v1/apis/webmasters/v3/rest

    https://searchconsole.googleapis.com/$discovery/rest

  • Alteração do conteúdo
    • O campo name foi modificado de webmasters para searchconsole.
    • O campo version foi modificado de v3 para v1.

Em caso de dúvidas, entre em contato pela comunidade da Central da Pesquisa ou no Twitter.

Postado por Nati Yosephian, Gilad Amar e Michael Huzman, equipe do Search Console