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, v13_0
é uma versão principal, enquanto
v13_1
é uma versão secundária.
Consulte as notas da versão para conferir as versões anteriores.
Versões principais
As versões de lançamento principais apresentam algumas alterações incompatíveis com versões anteriores.
A versão termina 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. Esse é um exemplo do 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 anterior, seu código poderá exigir mudanças quando você 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 disponibilizar um guia de migração para corrigir as mudanças interruptivas no seu código.
Veja alguns exemplos de alterações interruptivas:
- Remoção ou renomeação de um serviço, interface, campo, método ou valor de enumeração.
- Alterar o tipo de um campo.
- Alteração do formato de um nome de recurso.
- Alterar o formato do URL na definição de HTTP.
- Como mudar formatos de saída, como de
0
para--
como valor padrão. - Mudar o motivo do erro retornado de A para B.
Versões secundárias
As versões secundárias apresentam apenas mudanças compatíveis com versões anteriores. Para uma versão secundária,
o 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 causa falhas no código. É possível continuar usando as bibliotecas de cliente atuais.
As versões secundárias incluem novos recursos ou atualizações que não afetam o código existente. Se você quiser usar esses novos recursos, faça upgrade das bibliotecas de cliente para a versão mais recente.
Pôr do sol
Periodicamente, as versões mais antigas da API Google Ads precisarão ser desativadas. Postaremos avisos no Blog do desenvolvedor quando uma versão estiver prestes a ser desativada. A programação da descontinuação será atualizada com datas futuras de desativação.