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 sont abandonnées et finalement abandonnées. Lorsqu'une version est abandonnée, toutes les requêtes envoyées à cette version commencent à renvoyer des erreurs.
Si une version de l'API que vous utilisez est obsolète, vous devrez passer à une version plus récente avant la date d'abandon prévue. Ce guide explique comment déterminer si la version d'API que vous utilisez est obsolète et fournit les étapes de migration recommandées.
Étape 1: Identifiez la version que vous utilisez
Si vous gérez une application que vous pensez utiliser une version obsolète de l'API Campaign Manager 360, vous devez d'abord vérifier la version spécifique que 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 pour trouver la version de l'API utilisée par ces bibliothèques clientes et intégrations:
Nouvel éditeur Apps Script
Les informations de 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 "Version" correspond à la version de l'API Campaign Manager 360 actuellement utilisée.
Ancien éditeur Apps Script
Les informations de 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 "Version" correspond à la version de l'API Campaign Manager 360 actuellement utilisée.
C#
Les informations de 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 de version de la bibliothèque cliente des API Google pour Java sont exposées aux emplacements suivants:
- Spécifié dans l'ID d'artefact Maven.
<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 de 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 (v1/v2) n'est pas versionnée. La version de l'API à utiliser est spécifiée en tant qu'argument de l'outil de création de découverte:
discovery.build('dfareporting', 'v3.4', http=http)
Ruby
Les versions < 0.9 de la bibliothèque cliente des API Google pour Ruby ne sont pas numérotées. La version de l'API à utiliser est spécifiée en tant qu'argument du constructeur du service:
service = Google::APIClient::Service.new("dfareporting", "v3.4", { :application_name => "My application", :application_version => '1.0.0', :authorization => authorization } )
Pour les versions de la bibliothèque cliente des API Google pour Ruby >= 0.9, la version est exposée dans l'espace de noms du service:
Google.Apis.DfareportingV3_4
Notez la version que vous utilisez, car vous en aurez besoin plus tard.
Étape 2: Déterminez l'état de votre version
Le calendrier d'abandon indique l'état de chaque version actuellement prise en charge. 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'arrêt, vous utilisez une version entièrement prise en charge.
- Si des dates sont indiquées, la version que vous utilisez est actuellement obsolète et sera abandonnée à la date spécifiée.
- Si votre version n'est pas listée, elle a déjà été abandonnée et n'est plus prise en charge.
Si vous vous trouvez dans les cas de figure 2 ou 3 ci-dessus, vous devrez passer à une version plus récente pour éviter toute interruption de service. Nous vous recommandons de migrer vers la version la plus récente, qui figure en haut du tableau du calendrier d'abandon (à l'exception des versions bêta). Vous bénéficierez ainsi du délai maximal entre les mises à niveau.
Étape 3: Mettre à niveau les versions
Si vous avez déterminé que vous devez effectuer une migration, l'étape suivante consiste à mettre à jour votre intégration ou à obtenir une version mise à jour de votre bibliothèque cliente préférée. Notez que certaines bibliothèques clientes ne fournissent qu'une seule version qui fonctionne avec n'importe quelle version d'API, tandis que d'autres ont des versions distinctes pour chaque version. La liste ci-dessous fournit des informations générales sur la mise à niveau des intégrations et des bibliothèques clientes les plus utilisées.
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 à utiliser pour chaque script. Pour modifier la version utilisée par un script spécifique:
- 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
Google Apps Script est compatible avec toutes les versions de l'API Campaign Manager 360 et vous permet de sélectionner la version à utiliser pour chaque script. Pour modifier la version utilisée par un script spécifique:
- 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és 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 Google API pour Java fournit des builds distincts pour chaque version de l'API Campaign Manager 360, distribués 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 builds distincts pour chaque version de l'API Campaign Manager 360, distribués 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 build de la bibliothèque cliente des API Google pour Python (v1/v2) est compatible avec toutes les versions de l'API Campaign Manager 360. Il vous suffit de modifier la chaîne de version transmise en tant qu'argument au générateur de Discovery:
discovery.build('dfareporting', 'v3.4', http=http)
Ruby
La bibliothèque cliente des API Google pour Ruby v0.8 et les 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 } )
Étape 4: Différences entre les versions d'adresse
Nous nous efforçons de rendre nos nouvelles versions rétrocompatibles, ce qui signifie que la migration entre les versions d'API ne nécessitera pas de modifications de votre code. Lorsque cela n'est pas possible, nous annonçons les modifications qui nécessitent une action de la part des développeurs (également appelées modifications destructives) dans nos notes de version.
À ce stade, vous devez consulter nos notes de version, en commençant par la version qui suit celle à partir de laquelle vous êtes parti (que vous avez notée dans une section précédente) et en continuant jusqu'à la version vers laquelle vous effectuez la mise à niveau. Les sections des notes de version doivent être interprétées comme suit:
- Nouvelles fonctionnalités : fonctionnalité ajoutée.
- Abandon : fonctionnalité supprimée de l'API. Lorsque la fonctionnalité de remplacement sera disponible, elle sera décrite dans cette section.
- Problèmes connus : modifications qui ne sont pas des ajouts ni des suppressions. Par exemple, cette section peut couvrir des champs ou des méthodes qui ont été renommés, ou une logique de validation qui a changé.
Les fonctionnalités de la section Nouvelles fonctionnalités ne nécessitent pas de modification du code et peuvent être ignorées pour le moment. N'hésitez pas à revenir sur cette section plus tard si vous souhaitez tester une fonctionnalité que nous avons ajoutée.
En revanche, si vous constatez des modifications dans les sections Arrêts ou Problèmes connus, vous devrez peut-être prendre des mesures. Vous devez rechercher dans votre code si l'une des fonctionnalités supprimées ou modifiées est utilisée par votre application. Si c'est le cas, vous devrez modifier votre code pour tenir compte de ces modifications.
Rester informé
Comme indiqué précédemment, de nouvelles versions de l'API Campaign Manager 360 sont régulièrement publiées, alors que d'autres sont abandonnées. Les informations sur les nouvelles versions, les abandons et les arrêts sont publiées sur les canaux suivants:
- Blog pour les développeurs Google Ads (abonnez-vous pour recevoir des alertes par e-mail)
- Forum de l'API Campaign Manager 360
Nous vous recommandons de vous abonner à l'un ou à plusieurs de ces canaux pour vous tenir informé des dernières actualités sur les API.