Cette page a été traduite par l'API Cloud Translation.

Migrer vers une nouvelle version

De nouvelles versions de l'API Campaign Manager 360 sont publiées régulièrement. À mesure que de nouvelles versions sont publiées, les anciennes versions sont obsolètes et finissent par disparaître. Lorsqu'une version est abandonnée, toutes les requêtes sur cette version commencent à renvoyer des erreurs.

Si une version de l'API que vous utilisez est obsolète, vous devrez migrer vers une version plus récente avant la date d'abandon prévue. Ce guide explique comment déterminer si la version de l'API que vous utilisez est obsolète et propose les étapes de migration recommandées.

Étape 1: Déterminez la version que vous utilisez

Si vous gérez une application qui, selon vous, semble utiliser une version obsolète de l'API Campaign Manager 360, vous devez d'abord vérifier quelle version spécifique vous utilisez. Dans la plupart des cas, vous accédez à l'API via l'une de nos bibliothèques clientes spécifiques à chaque langage ou via une intégration officielle. Vous trouverez ci-dessous les instructions permettant d'identifier la version de l'API utilisée par ces bibliothèques clientes et intégrations:

Nouvel éditeur Apps Script

Les informations sur la version d'Apps Script sont affichées dans la boîte de dialogue des services avancés:

Dans l'éditeur Apps Script, cliquez sur Ajouter un service .
Recherchez l'API Campaign Manager 360 dans la liste des services disponibles.
La valeur sélectionnée dans le menu déroulant des versions correspond à la version de l'API Campaign Manager 360 actuellement utilisée.

Ancien éditeur Apps Script

Les informations sur la version d'Apps Script sont affichées dans la boîte de dialogue des services avancés:

Dans l'éditeur Apps Script, accédez à Resources > Advanced Google services (Ressources > Services avancés Google).
Recherchez l'API Campaign Manager 360 dans la liste des services disponibles.
La valeur sélectionnée dans le menu déroulant des versions correspond à la version de l'API Campaign Manager 360 actuellement utilisée.

C#

Les informations concernant la version de la bibliothèque cliente des API Google pour .NET sont exposées aux emplacements suivants:

Inclus dans le nom du package Nuget et l'espace de noms du service.
```
Google.Apis.Dfareporting.v3_4
```
Exposé via une propriété publique de DfareportingService.
```
Console.WriteLine(DfareportingService.Version);
```

Java

Les informations relatives à la version de la bibliothèque cliente des API Google pour Java sont exposées aux emplacements suivants:

Spécifié dans le Maven artifactId.

<dependency>
  <groupId>com.google.apis</groupId>
  <artifactId>google-api-services-dfareporting</artifactId>
  <version>v3.4-rev1-1.21.0</version>
</dependency>

Inclus dans le nom du fichier JAR.

google-api-services-dfareporting-v3.4-rev1-1.21.0.jar

Exposé via une propriété publique de Dfareporting.

System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);

PHP

Les informations de version de la bibliothèque cliente des API Google pour PHP sont exposées via une propriété publique de Google_Service_Dfareporting :

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

Python

La bibliothèque cliente des API Google pour Python ne possède pas de version. La version de l'API à utiliser est spécifiée en tant qu'argument pour l'outil de création de découverte :

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

Ruby

Les versions de la bibliothèque cliente des API Google pour Ruby < 0.9 ne sont pas gérées. La version de l'API à utiliser est spécifiée en tant qu'argument pour le constructeur de service :

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

Pour les versions suivantes de la bibliothèque cliente des API Google pour Ruby, la version est exposée dans l'espace de noms du service :

Google.Apis.DfareportingV3_4

Prenez note de la version que vous utilisez, car vous en aurez besoin ultérieurement.

Étape 2: Déterminez l'état de votre version

Le calendrier d'abandon indique l'état de chaque version actuellement compatible. Recherchez votre version dans cette liste et déterminez son état comme suit:

Si aucune date n'est indiquée dans les colonnes Date d'abandon et Date d'abandon, cela signifie que vous utilisez une version entièrement compatible.
Si des dates sont indiquées, cela signifie que la version que vous utilisez est obsolète et sera abandonnée à la date spécifiée.
Si votre version n'est pas répertoriée, c'est qu'elle a déjà été abandonnée et qu'elle n'est plus compatible.

Si vous tombez à la position 2 ou 3 ci-dessus, vous devrez migrer vers une version plus récente pour éviter une interruption de service. Nous vous recommandons d'effectuer la migration vers la version la plus récente, qui est indiquée en haut du tableau du calendrier d'abandon (hors versions bêta). Vous disposerez ainsi du délai maximal entre les mises à niveau.

Étape 3: Mettez à jour les versions

Si vous avez besoin de migrer, l'étape suivante consiste à mettre à jour votre intégration ou à obtenir une version actualisée de votre bibliothèque cliente préférée. Bien que certaines bibliothèques clientes ne puissent fournir qu'un seul build qui fonctionne avec n'importe quelle version de l'API, d'autres ont des compilations distinctes pour chaque version. La liste ci-dessous fournit des informations générales sur la mise à niveau des bibliothèques clientes et des intégrations les plus courantes.

Nouvel éditeur Apps Script

Google Apps Script est compatible avec toutes les versions de l'API Campaign Manager 360 et vous permet de sélectionner la version scriptée à utiliser. Pour modifier la version utilisée par un script particulier, procédez comme suit:

Dans l'éditeur Apps Script, cliquez sur Ajouter un service .
Recherchez l'API Campaign Manager 360 dans la liste des services disponibles.
Modifiez la version de l'API Campaign Manager 360 utilisée via le menu déroulant des versions.
Cliquez sur Ajouter pour enregistrer vos modifications.

Ancien éditeur Apps Script

Dans l'éditeur Apps Script, accédez à Resources > Advanced Google services (Ressources > Services avancés Google).
Recherchez l'API Campaign Manager 360 dans la liste des services disponibles.
Modifiez la version de l'API Campaign Manager 360 utilisée via le menu déroulant des versions.
Cliquez sur OK pour enregistrer les modifications.

C#

La bibliothèque cliente des API Google pour .NET fournit des builds distincts pour chaque version de l'API Campaign Manager 360, distribuée via Nuget.

Pour obtenir des instructions d'installation détaillées ou d'autres options de téléchargement, consultez la documentation de la bibliothèque cliente.

Java

La bibliothèque cliente des API Google pour Java fournit des versions distinctes pour chaque version de l'API Campaign Manager 360, distribuée via Maven.

Pour obtenir des instructions d'installation détaillées ou d'autres options de téléchargement, consultez la documentation de la bibliothèque cliente.

PHP

La bibliothèque cliente des API Google pour PHP fournit des versions distinctes pour chaque version de l'API Campaign Manager 360, distribuée via Packagist.

Pour obtenir des instructions d'installation détaillées ou d'autres options de téléchargement, consultez la documentation de la bibliothèque cliente.

Python

Chaque version de la bibliothèque cliente des API Google pour Python est compatible avec toutes les versions de l'API Campaign Manager 360. Il vous suffit de mettre à jour la chaîne de version transmise en tant qu'argument à l'outil de création de découverte.

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

Pour obtenir des instructions d'installation détaillées ou d'autres options de téléchargement, consultez la documentation de la bibliothèque cliente.

Ruby

La bibliothèque cliente des API Google pour Ruby v0.8 et versions antérieures est compatible avec toutes les versions de l'API Campaign Manager 360. Il vous suffit de mettre à jour la chaîne de version transmise en tant qu'argument au constructeur du service :

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

La bibliothèque cliente des API Google pour Ruby v0.9+ fournit des versions distinctes pour chaque version de l'API Campaign Manager 360, distribuée via RubyGems. Pour obtenir des instructions d'installation détaillées ou d'autres options de téléchargement, consultez la documentation de la bibliothèque cliente.

Étape 4: Traitez les différences de version

Nous mettons tout en œuvre pour rendre nos nouvelles versions rétrocompatibles, ce qui signifie que la migration d'une version d'API à une autre n'est pas nécessaire. Lorsque ce n'est pas possible, nous annonçons les changements qui nécessitent une action de la part des développeurs (également appelés modifications destructives) dans nos notes de version.

À ce stade, nous vous recommandons de consulter nos notes de version, en commençant par la version après laquelle vous avez commencé (comme vous l'avez noté dans une section précédente) jusqu'à la version que vous mettez à niveau. Les sections des notes de version doivent être interprétées comme suit:

Nouvelles fonctionnalités : nouvelles fonctionnalités.
Arrêts : fonctionnalité qui a été supprimée de l'API. Le cas échéant, la fonctionnalité de remplacement sera traitée dans cette section.
Problèmes connus : modifications qui ne sont ni des ajouts, ni des suppressions Par exemple, cette section peut couvrir les champs ou les méthodes qui ont été renommés, ou la logique de validation qui a été modifiée.

La fonctionnalité de Nouvelles fonctionnalités ne nécessitera pas de modification de code et peut être ignorée pour le moment. N'hésitez pas à revenir à cette section ultérieurement si vous souhaitez tester quelque chose que nous avons ajouté.

En revanche, si vous trouvez des modifications dans les sections Couches de soleil ou Problèmes connus, vous devrez peut-être prendre des mesures. Vous devez parcourir votre code pour déterminer si l'une des fonctionnalités supprimées ou modifiées est utilisée par votre application. Si c'est le cas, vous devrez mettre à jour votre code pour tenir compte de ces changements

Actualités

Comme mentionné précédemment, les versions et abandons de l'API Campaign Manager 360 se produisent régulièrement. Des informations sur les nouveautés, les abandons et les abandons sont publiées sur les chaînes suivantes:

Nous vous recommandons de vous abonner à une ou plusieurs de ces chaînes pour vous tenir au courant des dernières actualités concernant l'API.