Controle de versões

Criação de versões semânticas

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, v11_0 é uma versão principal, e v11_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 apresentam algumas alterações 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 diferente. 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 ao mudar para o novo endpoint. 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 precisa ser usado para corrigir alterações interruptivas no código.

Veja alguns exemplos de alterações interruptivas:

  • Remoção ou renomeação de um valor de serviço, interface, campo, método ou enumeração.
  • Alteração do tipo de um campo.
  • Alteração de um formato de nome de recurso.
  • Alteração do formato do URL na definição de HTTP.
  • Como mudar formatos de saída, como 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 fazem apenas alterações 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 causará falha no seu 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 seu 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. Publicaremos avisos no blog do desenvolvedor quando uma versão estiver prestes a ser desativada. A programação da suspensão de uso é atualizada com datas futuras de desativação.