Controle de versão semântico
A Google Ads API segue o controle de versões semântico, onde há uma versão principal e uma secundária. O formato da versão é MAJOR.MINOR
ou
vMAJOR_MINOR
. Por exemplo, v17_0
é uma versão principal e
v17_1
é uma versão secundária.
Consulte as notas da versão para ver as versões anteriores.
Versões principais
As principais versões de lançamento introduzem algumas alterações interruptivas 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 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 mais antiga, seu código poderá exigir alterações 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 houver uma versão principal lançada, forneceremos um guia de migração que você precisa analisar para corrigir alterações interruptivas no seu 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.
- Alterar o formato de um nome de recurso.
- Alterar o formato do URL na definição de HTTP.
- Mudar formatos de saída, por exemplo, de
0
para--
como valor padrão. - Alterar 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. Em 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 causará 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 atual. Se você quiser usar esses novos recursos, faça upgrade das suas 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 para desenvolvedores quando uma versão estiver prestes a ser desativada. O cronograma de descontinuação é atualizado com datas de desativação futuras.