Controllo delle versioni nell'API Search Ads 360 Reporting

L'API Search Ads 360 Reporting utilizza il controllo delle versioni semantico.

Esistono versioni principali e secondarie, formattate come vMAJOR_MINOR. Ad esempio, v0_0 è la prima versione principale e v0_1 la prima versione secondaria. Il suffisso del numero di versione indica il tipo di versione: per le versioni principali è sempre zero e per le versioni secondarie è sempre maggiore di zero.

Versioni principali

Le release principali introducono modifiche che provocano un errore, ovvero modifiche non compatibili con le versioni precedenti.

Ogni versione principale ha un endpoint separato, ad esempio:

https://searchads360.googleapis.com/v0

https://searchads360.googleapis.com/v1

Quando esegui l'upgrade da una versione principale a un'altra, potresti dover modificare il codice prima di passare all'endpoint della nuova versione principale.

Se utilizzi una libreria client, devi eseguire l'upgrade alla versione più recente. Le nuove versioni principali forniscono una guida alla migrazione per aiutarti a correggere eventuali modifiche che provocano un errore nel codice.

Ecco alcuni esempi di modifiche che comportano interruzioni:

  • Rimozione o ridenominazione di un servizio, un'interfaccia, un campo, un metodo o un valore di enum.
  • Modifica del tipo di un campo.
  • Modifica del formato del nome di una risorsa.
  • Modifica del formato dell'URL nella definizione HTTP.
  • Modifica dei formati di output, ad esempio la sostituzione di 0 con -- come valore predefinito.
  • Modifica del motivo dell'errore restituito da A a B.

Versioni secondarie

Le versioni minori introducono solo modifiche compatibili con le versioni precedenti.

Quando viene rilasciata una versione secondaria, l'endpoint già in uso viene aggiornato automaticamente. Il codice non viene interrotto. Puoi continuare a utilizzare la tua libreria client esistente.

Le versioni minori includono nuove funzionalità o aggiornamenti che non influiscono sul codice esistente. Se vuoi utilizzare le nuove funzionalità, devi eseguire l'upgrade della libreria client alla versione più recente.

Tramonti

Quando è prevista il ritiro di una versione precedente dell'API Search Ads 360 Reporting, pubblichiamo una notifica nel gruppo Google searchads-api-announcements.