Controle de versões

Controle de versão semântica

A API Google Ads segue o controle de versões semânticas, em que há uma versão principal e uma secundária. O formato da versão é MAJOR.MINOR ou vMAJOR_MINOR. Por exemplo, v18_0 é uma versão principal, enquanto v18_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 importantes e 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. Este é um exemplo de URL em que 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 mudar para o novo endpoint da versão principal. Se você estiver usando nossas bibliotecas de cliente, atualize para a versão mais recente. Quando uma versão principal for lançada, vamos fornecer um guia de migração que deve ser usado para corrigir as mudanças de interrupção 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.
• Mudanças nos formatos de saída, como a mudança 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 causar a quebra do 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 você quiser usar esses novos recursos, atualize as bibliotecas de cliente para a versão mais recente.

Elementos desativados

Periodicamente, 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 descontinuação é atualizada com datas de desativação futuras.