Controle de versões na API Search Ads 360 Reporting

A API Search Ads 360 Reporting usa versionamento 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 de versão: para versões principais, ele é sempre zero, e para versões secundárias, é sempre maior que zero.

Versões principais

As versões principais introduzem mudanças importantes, 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 mudar o código antes de mudar para o novo endpoint da versão principal.

Se você usa uma biblioteca de cliente, faça upgrade para a versão mais recente. As novas versões principais fornecem um guia de migração para ajudar a corrigir mudanças interruptivas no código.

Confira alguns exemplos de mudanças incompatíveis:

  • Remover ou renomear um serviço, interface, campo, método ou valor de tipo enumerado.
  • Alterar o tipo de um campo.
  • Mudar o formato do nome de um recurso.
  • Mudança no formato do URL na definição de HTTP.
  • Alterar formatos de saída, como mudar 0 para -- como valor padrão.
  • Mudança do 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 a quebra do código. Você pode continuar usando a biblioteca de cliente atual.

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

Elementos desativados

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