Controle de versão semântico
A API Google Ads segue o controle de versões semântico com um número de versão principal e um secundário. As versões são escritas como MAJOR.MINOR ou vMAJOR.MINOR.
Por exemplo, v26.0 (ou v26) é uma versão principal, enquanto v26.1 é uma versão secundária.
Consulte as notas da versão para mais detalhes sobre as versões atuais e anteriores.
Versões principais
As versões de lançamento principais introduzem mudanças interruptivas e incompatíveis com versões anteriores. A
versão 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, v26):
https://googleads.googleapis.com/vX
Se você estiver fazendo upgrade de uma versão principal mais antiga, seu código poderá exigir alterações ao mudar 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 as alterações interruptivas no seu código.
Exemplos de alterações interruptivas:
- Remover ou renomear um serviço, uma interface, um campo, um método ou um valor de tipo enumerado.
- Alteração do tipo de um campo.
- Alterar o formato de um nome de recurso.
- Alterar o formato do URL na definição de HTTP.
- Alterar formatos de saída, como mudar 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,
v26.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 alterar o caminho da versão nos URLs de endpoint, e o código atual
continua funcionando sem interrupções.
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 da biblioteca de cliente 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, posteriormente, desativadas:
- Descontinuada: quando uma versão principal (como
v26) é lançada, todas as versões principais anteriores são marcadas como descontinuadas. As chamadas de API para versões descontinuadas continuam funcionando até a data de desativação, e as versões atuais da biblioteca de cliente continuam oferecendo suporte a elas, embora as versões subsequentes 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.
Publicamos avisos no blog do desenvolvedor antes da desativação de versões. Confira a programação de descontinuação e desativação para datas ativas, descontinuadas e programadas para desativação.