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 è il
prima versione maggiore e v0_1 la prima versione secondaria. Il suffisso del
indica il tipo di versione: per le versioni principali è sempre zero,
e per le versioni secondarie è sempre maggiore di zero.
Versioni principali
Le versioni principali introducono modifiche che provocano un errore, 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, potrebbe essere necessario modificare prima di passare al nuovo endpoint della versione principale.
Se utilizzi una libreria client, devi eseguire l'upgrade alla versione più recente. Le nuove versioni principali offrono guida alla migrazione, che ti aiuterà a correggere eventuali modifiche che provocano errori nel codice.
Ecco alcuni esempi di modifiche che provocano un errore:
- Rimozione o ridenominazione di un servizio, un'interfaccia, un campo, un metodo o un valore enum.
- Modifica del tipo di un campo.
- Modifica del formato del nome della risorsa.
- Modifica del formato dell'URL nella definizione HTTP.
- Modifica dei formati di output, ad esempio la modifica di
0in--come valore predefinito. - Modifica del motivo dell'errore restituito da A a B.
Versioni secondarie
Le versioni secondarie introducono solo modifiche compatibili con le versioni precedenti.
Quando viene rilasciata una versione secondaria, l'endpoint già in uso viene viene aggiornata automaticamente. Ciò non causa l'interruzione del codice. Puoi continuare per utilizzare la libreria client esistente.
Le versioni secondarie includono nuove funzionalità o aggiornamenti che non influiscono sulle le API nel tuo codice. Se vuoi utilizzare le nuove funzionalità, devi eseguire l'upgrade del tuo libreria client alla versione più recente completamente gestita.
Tramonti
Quando è prevista il ritiro di una versione precedente dell'API Search Ads 360 Reporting, pubblicare una notifica sul gruppo Google searchads-api-announcements.