Esegui la migrazione a una nuova versione

Nuove versioni dell'API Campaign Manager 360 vengono rilasciate regolarmente. Man mano che vengono rilasciate nuove versioni, le versioni precedenti vengono ritirate e alla fine vengono ritirate. Quando una versione viene disattivata, tutte le richieste relative a quella versione iniziano a restituire errori.

Se una versione dell'API che stai utilizzando è deprecata, dovrai eseguire la migrazione a una versione più recente prima della data di disattivazione pianificata. Questa guida fornisce dettagli su come stabilire se la versione dell'API che stai utilizzando è deprecata e illustra i passaggi consigliati per la migrazione.

Passaggio 1: determina la versione in uso

Se mantieni presente un'applicazione che ritieni possa utilizzare una versione deprecata dell'API Campaign Manager 360, devi prima verificare quale versione specifica stai utilizzando. Nella maggior parte dei casi, accederai all'API tramite una delle nostre librerie client specifiche per i vari linguaggi o tramite un'integrazione ufficiale. Di seguito sono riportate le istruzioni per trovare la versione API utilizzata da queste librerie e integrazioni client:

Nuovo editor di Apps Script

Le informazioni sulla versione di Apps Script vengono mostrate nella finestra di dialogo dei servizi avanzati:

  1. Nell'editor di Apps Script, fai clic su Aggiungi un servizio .
  2. Individua l'API Campaign Manager 360 nell'elenco dei servizi disponibili.
  3. Il valore selezionato nel menu a discesa delle versioni è la versione dell'API Campaign Manager 360 attualmente in uso.

Editor precedente di Apps Script

Le informazioni sulla versione di Apps Script vengono mostrate nella finestra di dialogo dei servizi avanzati:

  1. Nell'editor di Apps Script, vai a Risorse > Servizi Google avanzati.
  2. Individua l'API Campaign Manager 360 nell'elenco dei servizi disponibili.
  3. Il valore selezionato nel menu a discesa delle versioni è la versione dell'API Campaign Manager 360 attualmente in uso.

C#

Le informazioni sulla versione per la libreria client delle API di Google per .NET sono esposte nelle seguenti posizioni:

  1. Incluso nel nome del pacchetto nuget e nello spazio dei nomi del servizio.
    Google.Apis.Dfareporting.v3_4
  2. Sono state esposte tramite una proprietà pubblica di DfareportingService.
    Console.WriteLine(DfareportingService.Version);

Java

Le informazioni sulla versione per la libreria client delle API di Google per Java sono visibili nelle seguenti posizioni:

  1. Specificato nell'elemento artifactId.
    <dependency>
      <groupId>com.google.apis</groupId>
      <artifactId>google-api-services-dfareporting</artifactId>
      <version>v3.4-rev1-1.21.0</version>
    </dependency>
  2. Incluso nel nome file JAR.
    google-api-services-dfareporting-v3.4-rev1-1.21.0.jar
  3. Sono state esposte tramite una proprietà pubblica di Dfareporting.
    System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);

PHP

Le informazioni sulla versione della libreria client delle API di Google per PHP sono esposte tramite una proprietà pubblica Google_Service_Dfareporting:

$service = new Google_Service_Dfareporting($client)
print $service->version;

Python

La libreria client delle API di Google per Python non è sottoposta a controllo delle versioni. La versione API da utilizzare è specificata come argomento nel builder di rilevamento:

discovery.build('dfareporting', 'v3.4', http=http)

Ruby

La libreria client delle API di Google per le versioni Ruby < 0.9 non è sottoposta al controllo delle versioni. La versione dell'API da utilizzare è specificata come argomento dal costruttore di servizi:

service = Google::APIClient::Service.new("dfareporting", "v3.4",
    {
      :application_name => "My application",
      :application_version => '1.0.0',
      :authorization => authorization
    }
)

Per la libreria client delle API di Google per le versioni Ruby >= 0.9, la versione è esposta nello spazio dei nomi del servizio:

Google.Apis.DfareportingV3_4

Prendi nota della versione utilizzata, perché avrai bisogno di queste informazioni in seguito.

Passaggio 2: determina lo stato della versione

Nella pagina Programma di ritiro è indicato lo stato di ogni versione attualmente supportata. Individua la tua versione in questo elenco e determinane lo stato nel seguente modo:

  1. Se nelle colonne Data di ritiro e Data di ritiro sono indicate date, significa che stai utilizzando una versione completamente supportata.
  2. Se le date sono elencate, la versione che stai utilizzando è al momento obsoleta e verrà ritirata nella data specificata.
  3. Se la tua versione non è presente nell'elenco, è già stata disattivata e non è più supportata.

Se rientri nei punti 2 o 3 di cui sopra, dovrai eseguire la migrazione a una versione più recente per evitare l'interruzione del servizio. Ti consigliamo di eseguire la migrazione alla versione più recente, indicata nella parte superiore della tabella del programma di ritiro (escluse le release beta). In questo modo potrai usufruire del periodo di tempo massimo tra un upgrade e l'altro.

Passaggio 3: esegui l'upgrade delle versioni

Se hai stabilito che devi eseguire la migrazione, il passaggio successivo consiste nell'aggiornare l'integrazione o ottenere una build aggiornata della libreria client preferita. Tieni presente che, sebbene alcune librerie client possano fornire una sola build che funziona con qualsiasi versione dell'API, altre avranno build separate per ogni versione. L'elenco che segue fornisce informazioni generali sull'upgrade per le librerie e le integrazioni client più usate.

Nuovo editor di Apps Script

Google Apps Script supporta tutte le versioni dell'API Campaign Manager 360 e ti consente di selezionare la versione da utilizzare per ogni singolo script. Per modificare la versione utilizzata da un determinato script:

  1. Nell'editor di Apps Script, fai clic su Aggiungi un servizio .
  2. Individua l'API Campaign Manager 360 nell'elenco dei servizi disponibili.
  3. Modifica la versione dell'API Campaign Manager 360 in uso tramite il menu a discesa della versione.
  4. Fai clic su Aggiungi per salvare le modifiche.

Editor precedente di Apps Script

Google Apps Script supporta tutte le versioni dell'API Campaign Manager 360 e ti consente di selezionare la versione da utilizzare per ogni singolo script. Per modificare la versione utilizzata da un determinato script:

  1. Nell'editor di Apps Script, vai a Risorse > Servizi Google avanzati.
  2. Individua l'API Campaign Manager 360 nell'elenco dei servizi disponibili.
  3. Modifica la versione dell'API Campaign Manager 360 in uso tramite il menu a discesa della versione.
  4. Fai clic su OK per salvare le modifiche.

C#

La libreria client delle API di Google per .NET fornisce build separate per ogni versione dell'API Campaign Manager 360, distribuite tramite Nuget.

Per istruzioni dettagliate sull'installazione o sulle opzioni di download alternative, consulta la documentazione relativa alla libreria client.

Java

La libreria client delle API di Google per Java fornisce build separate per ogni versione dell'API Campaign Manager 360, distribuite tramite Maven.

Per istruzioni dettagliate sull'installazione o sulle opzioni di download alternative, consulta la documentazione relativa alla libreria client.

PHP

La libreria client delle API di Google per PHP fornisce build separate per ogni versione dell'API Campaign Manager 360, distribuite tramite Packagist.

Per istruzioni dettagliate sull'installazione o sulle opzioni di download alternative, consulta la documentazione relativa alla libreria client.

Python

Ogni build della libreria client delle API di Google per Python supporta tutte le versioni dell'API Campaign Manager 360. Aggiorna semplicemente la stringa di versione che viene passata come argomento al builder di rilevamento:

discovery.build('dfareporting', 'v3.4', http=http)
Per istruzioni dettagliate sull'installazione o opzioni di download alternative, consulta la documentazione della libreria client.

Ruby

La libreria client delle API di Google per Ruby v0.8 e versioni precedenti supporta tutte le versioni dell'API Campaign Manager 360. Aggiorna semplicemente la stringa di versione trasferita come argomento al costruttore di servizi:

service = Google::APIClient::Service.new("dfareporting", "v3.4",
    {
      :application_name => "My application",
      :application_version => '1.0.0',
      :authorization => authorization
    }
)
La libreria client delle API di Google per Ruby v0.9+ fornisce build separate per ogni versione dell'API Campaign Manager 360, distribuite tramite RubyGems. Per istruzioni dettagliate sull'installazione o sulle opzioni di download alternative, consulta la documentazione relativa alla libreria client.

Passaggio 4: risolvi le differenze di versione

Cerchiamo di rendere le nostre nuove release compatibili con le versioni precedenti, il che significa che la migrazione tra le versioni API non richiederà modifiche al codice. Quando questo non è possibile, annunciamo le modifiche che richiedono un intervento da parte degli sviluppatori (note anche come modifiche che provocano un errore) nelle nostre note di rilascio.

A questo punto, dovresti esaminare le nostre note di rilascio, iniziando con la versione successiva a quella da cui hai iniziato (nella nota precedente) e continuando con la versione a cui stai eseguendo l'upgrade. Le sezioni delle note di rilascio devono essere interpretate in questo modo:

  • Nuove funzionalità: sono state aggiunte nuove funzionalità.
  • Tramonti: funzionalità che è stata rimossa dall'API. La funzionalità di sostituzione verrà illustrata in questa sezione, se disponibile.
  • Problemi noti: modifiche che non sono aggiunte o rimozioni. Ad esempio, questa sezione potrebbe riguardare campi o metodi che sono stati rinominati o una logica di convalida che è cambiata.

Per ora la funzionalità in Nuove funzionalità non richiede modifiche al codice e può essere ignorata. Non esitare a tornare in questa sezione in un secondo momento se desideri provare qualcosa che abbiamo aggiunto.

Se invece rilevi modifiche nella sezione Tramonti o Problemi noti, potresti dover intervenire. Devi cercare tra il codice per determinare se una qualsiasi delle funzionalità rimosse o modificate viene utilizzata dalla tua applicazione. In tal caso, dovrai aggiornare il codice per risolvere queste modifiche

Seguire le novità

Come accennato in precedenza, le release dell'API Campaign Manager 360 e le disattivazioni avvengono regolarmente. Gli aggiornamenti sulle nuove uscite, sui ritiri e sui tramonti vengono pubblicati sui seguenti canali:

Ti consigliamo di iscriverti a uno o più di questi canali per rimanere al corrente delle ultime novità relative all'API.