Controle de versões

Controle de versão semântico

A Google Ads API 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, v14_0 é a versão principal e v14_1 é uma versão secundária.

Consulte as notas da versão para consultar 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 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. 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, 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 uma versão principal é lançada, oferecemos um guia de migração que você precisa seguir para corrigir alterações interruptivas no código.

Veja alguns exemplos de alterações interruptivas:

  • Remover ou renomear um serviço, interface, campo, método ou valor de enumeração.
  • Alteração do tipo de um campo.
  • Alteração de um formato de nome de recurso.
  • Mudança do formato do URL na definição de HTTP.
  • Mudança nos formatos de saída, como a mudança de 0 para -- como valor padrão
  • Mudando o 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 de 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 falhas no código. Você pode continuar usando suas 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 precisam ser desativadas. Postaremos avisos no blog para desenvolvedores quando uma versão estiver prestes a ser desativada. A programação de descontinuação é atualizada com datas futuras de desativação.