Controle de versões na API Search Ads 360 Reporting

A API Search Ads 360 Reporting usa o controle de versões semântico.

Existem versões principais e secundárias, formatadas como vMAJOR_MINOR: Por exemplo, v0_0 é o primeira versão principal e v0_1 a primeira versão secundária. O sufixo do elemento número da versão indica o tipo: para versões principais, é sempre zero, e para versões secundárias é sempre maior que zero.

Versões principais

Lançamentos importantes introduzem alterações interruptivas, ou seja, mudanças que não são compatível com versões anteriores.

Cada versão principal tem um endpoint separado, por exemplo:

https://searchads360.googleapis.com/v0

https://searchads360.googleapis.com/v1

Ao fazer o upgrade de uma versão principal para outra, pode ser necessário alterar seu antes de mudar para o novo endpoint da versão principal.

Se você usa uma biblioteca de cliente, será necessário atualizar para a versão mais recente. As novas versões principais oferecem guia de migração para ajudar você a corrigir alterações interruptivas no seu código.

Exemplos de alterações interruptivas:

  • Remover ou renomear 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 de HTTP.
  • Mudar formatos de saída, por exemplo, mudar 0 para -- como o valor padrão.
  • Alterar o motivo do erro retornado de A para B.

Versões secundárias

As versões secundárias introduzem apenas alterações compatíveis com versões anteriores.

Quando uma versão secundária é lançada, o endpoint que já está em uso é atualizadas automaticamente. Isso não causa falhas no código. Você pode continuar para usar sua biblioteca de cliente atual.

As versões secundárias incluem novos recursos ou atualizações que não afetam a o código-fonte. Se quiser usar os novos recursos, você precisará fazer upgrade do biblioteca de cliente para a versão mais recente para a versão anterior.

Elementos desativados

Quando uma versão mais antiga da API Search Ads 360 Reporting está programada para ser desativada, postará um aviso no grupo do Google searchads-api-announcements////// envio-/ som.