Controle de versões na API Search Ads 360 Reporting

A API Search Ads 360 Reporting usa o controle de versões semântico.

Há versões principais e secundárias, formatadas como vMAJOR_MINOR. Por exemplo, v0_0 é a primeira versão principal e v0_1 a primeira versão secundária. O sufixo do número da versão indica o tipo da versão: para versões principais, é sempre zero e, para versões secundárias, é sempre maior que zero.

Versões principais

As versões principais introduzem alterações interruptivas, ou seja, mudanças que não são compatíveis com versões anteriores.

Cada versão principal tem um endpoint separado, por exemplo:

https://searchads360.googleapis.com/v0

https://searchads360.googleapis.com/v1

Ao fazer upgrade de uma versão principal para outra, talvez seja necessário alterar o código antes de alternar para o endpoint da nova versão principal.

Se você usa uma biblioteca de cliente, será necessário fazer upgrade para a versão mais recente. As novas versões principais fornecem um guia de migração para ajudar você a corrigir alterações interruptivas no código.

Exemplos de alterações interruptivas:

  • Remover ou renomear um serviço, interface, campo, método ou valor de enumeração.
  • Alterar o tipo de um campo.
  • Alteração de um formato de nome de recurso.
  • Alterar o formato do URL na definição de HTTP.
  • Mudança de formatos de saída, por exemplo, mudar 0 para -- como o valor padrão.
  • Alterando o motivo do erro retornado de A para B.

Versões secundárias

As versões secundárias introduzem apenas mudanças compatíveis com versões anteriores.

Quando uma versão secundária é lançada, o endpoint que já está em uso é atualizado automaticamente. Isso não causa falhas no código. Você pode continuar usando sua biblioteca de cliente existente.

As versões secundárias incluem novos recursos ou atualizações que não afetam o código atual. Se você quiser usar os novos recursos, precisará fazer upgrade da sua biblioteca de cliente para a versão mais recente.

Pôr do sol

Quando uma versão mais antiga da API Search Ads 360 Reporting está programada para ser desativada, postamos um aviso no grupo do Google searchads-api-announcements.