Controle de versão semântico
A API Google Ads segue o controle de versão semântico com um número de versão principal e
um número de versão secundária. As versões são escritas como MAJOR.MINOR ou vMAJOR.MINOR.
Por exemplo, v25.0 (ou v25) é uma versão principal, enquanto v25.1 é uma versão secundária.
Consulte as notas da versão para saber mais sobre as versões atuais e anteriores.
Versões principais
As versões principais introduzem mudanças interruptivas e incompatíveis com versões anteriores. O
lançamento inicial de uma versão principal termina em zero (vX.0 ou vX, em que X é
o número da versão principal).
Cada versão principal tem um caminho de endpoint REST e gRPC separado (vX), que não inclui o sufixo da versão secundária. No URL a seguir, X é o número da versão principal (por exemplo, v25):
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 ao alternar para o novo endpoint da versão principal. Se você estiver usando nossas bibliotecas de cliente, faça upgrade para a versão da biblioteca de cliente que oferece suporte à nova versão principal. Quando uma versão principal é lançada, fornecemos um guia de upgrade para ajudar você a resolver mudanças incompatíveis no seu código.
Exemplos de mudanças interruptivas:
- Remover ou renomear um serviço, uma interface, um campo, um método ou um valor de enumeração.
- Mudar o tipo de um campo.
- Mudar o formato do nome de um recurso.
- Mudar o formato do URL na definição HTTP.
- Mudar formatos de saída, como alterar valores padrão.
- Mudança do 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. Para uma versão secundária, vMAJOR.MINOR tem um número MINOR maior que zero (por exemplo, v25.1).
Quando uma versão secundária é lançada, o endpoint da versão principal atual
(https://googleads.googleapis.com/vX) é atualizado automaticamente no local. Não é necessário mudar o caminho da versão nos URLs de endpoint, e o código atual
continua funcionando sem falhas.
As versões secundárias adicionam recursos ou atualizações que não afetam o código atual. Para usar campos ou recursos de uma versão secundária com uma biblioteca de cliente, faça upgrade para uma versão que inclua as definições da versão secundária.
Descontinuação e desativação
Periodicamente, as versões mais antigas da API Google Ads são descontinuadas e depois desativadas:
- Descontinuada: quando uma versão principal (como
v25) é lançada, todas as versões principais anteriores são marcadas como descontinuadas. As chamadas de API para versões descontinuadas continuam sendo bem-sucedidas até a data de descontinuação, e as versões atuais da biblioteca de cliente continuam oferecendo suporte a elas, embora as versões seguintes da biblioteca de cliente omitam as versões descontinuadas da API para reduzir o tamanho do pacote. - Desativação: uma versão é desativada na data de desativação, e todas as chamadas de API para o endpoint dela falham.
Postamos avisos no blog para desenvolvedores antes da descontinuação de versões. Confira a programação de descontinuação e desativação para datas ativas, descontinuadas e programadas.