Controle de versões

Controle de versão semântico

A API Google Ads segue o controle de versões semântico, em que há uma versão principal e uma secundária. O formato da versão é MAJOR.MINOR ou vMAJOR_MINOR. Por exemplo, v20_0 é uma versão principal, enquanto v20_1 é uma versão secundária.

Consulte as notas da versão para versões anteriores.

Versões principais

As versões principais introduzem algumas mudanças incompatíveis com versões anteriores. A versão terminaria em zero com o formato vX_0, em que X é o número da versão principal.

Cada versão principal tem um endpoint separado. Neste exemplo de URL, X é o número da versão principal.

https://googleads.googleapis.com/vX

Se você estiver fazendo upgrade de uma versão principal mais antiga, talvez seja necessário mudar o código ao alternar para o novo endpoint da versão principal. Se você estiver usando nossas bibliotecas de cliente, faça upgrade para a versão mais recente. Quando uma versão principal for lançada, vamos fornecer um guia de migração que você precisa seguir para corrigir mudanças incompatíveis no seu código.

Exemplos de mudanças incompatíveis com versões anteriores:

  • Remover ou renomear um valor de enum, método, campo, interface ou serviço.
  • Mudar o tipo de um campo.
  • Como mudar o formato de um nome de recurso.
  • Como mudar o formato do URL na definição de HTTP.
  • Mudar formatos de saída, como de 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 só introduzem mudanças compatíveis com versões anteriores. Para uma versão secundária, vMAJOR_MINOR teria um número MINOR maior que zero.

Quando uma versão secundária é lançada, o endpoint que já está em uso é atualizado automaticamente. Isso não vai quebrar seu código. Você pode continuar usando as bibliotecas de cliente atuais.

As versões secundárias incluem novos recursos ou atualizações que não afetam seu código atual. Se quiser usar esses novos recursos, faça upgrade das suas bibliotecas de cliente para a versão mais recente.

Elementos desativados

Periodicamente, as versões mais antigas da API Google Ads precisam ser desativadas. Vamos postar avisos no blog para desenvolvedores quando uma versão estiver prestes a ser desativada. A programação de suspensão de uso é atualizada com as datas futuras de desativação.