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, v16_0 é a versão principal, enquanto v16_1 é uma versão secundária.

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

Versões principais

As principais versões de lançamento introduzem algumas alterações incompatíveis com versões anteriores e interruptivas. 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 quando você alternar para o novo endpoint da versão principal. Se você estiver usando nossas bibliotecas de cliente, atualize para a versão mais recente. Quando houver uma versão principal lançada, forneceremos um guia de migração que você deve seguir para corrigir quaisquer alterações interruptivas em seu código.

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.
  • Alterar o formato de um nome de recurso.
  • Alterar o formato do URL na definição HTTP.
  • Mudança de formatos de saída, como a mudança de 0 para -- como valor padrão.
  • Alterando 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, vMAJOR_MINOR teria um número MINOR maior que zero.

Quando uma versão secundária for lançada, o endpoint que já está em uso será atualizado automaticamente. Isso não vai causar falhas no código. Você pode continuar usando suas bibliotecas de cliente existentes.

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