De nouvelles versions de l'API Campaign Manager 360 sont publiées régulièrement. À mesure que de nouvelles versions sont publiées, les versions antérieures sont abandonnées, puis supprimées. Lorsqu'une version est abandonnée, toutes les requêtes qui lui sont adressées commencent à renvoyer des erreurs.
Si la version que vous utilisez est obsolète, vous devez effectuer la mise à niveau dès que possible pour éviter toute interruption de service.
Étape 1 : Déterminez la version que vous utilisez
Vous pouvez déterminer la version de l'API que vous utilisez en suivant les instructions ci-dessous. Dans la plupart des cas, vous accéderez à l'API à l'aide de l'une de nos bibliothèques clientes spécifiques à un langage ou d'une intégration officielle.
Nouvel éditeur Apps Script
Les informations sur la version d'Apps Script sont disponibles 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 utilisée.
Ancien éditeur Apps Script
Les informations sur la version d'Apps Script sont disponibles dans la boîte de dialogue des services avancés :
- Dans l'éditeur Apps Script, accédez à 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 utilisée.
C#
Les informations sur la version de la bibliothèque cliente des API Google pour .NET sont disponibles aux emplacements suivants :
- Inclus dans le nom du package NuGet et l'espace de noms du service.
Google.Apis.Dfareporting.v3_4
- Exposé à l'aide d'une propriété publique de
DfareportingService.Console.WriteLine(DfareportingService.Version);
Java
Les informations sur la version de la bibliothèque cliente des API Google pour Java sont disponibles aux emplacements suivants :
- Spécifié dans l'artifactId 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é à l'aide d'une propriété publique de
Dfareporting.System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);
PHP
Les informations sur la version de la bibliothèque cliente des API Google pour PHP sont exposées à l'aide d'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 du générateur de découverte :
discovery.build('dfareporting', 'v3.4', http=http)
Ruby
Les versions de la bibliothèque cliente des API Google pour Ruby antérieures à 0.9 ne sont pas versionnées. La version de l'API à utiliser est spécifiée en tant qu'argument du 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 de la bibliothèque cliente des API Google pour Ruby supérieures ou égales à 0.9, la version est exposée dans l'espace de noms du service :
Google.Apis.DfareportingV3_4
Étape 2 : Déterminez l'état de votre version
Consultez le calendrier d'abandon pour connaître l'état de votre version. Si votre version n'est pas listée, cela signifie qu'elle a été abandonnée et n'est plus compatible.
Si votre version est listée, consultez les colonnes Date d'abandon et Date de fin de vie :
- Si aucune date n'est indiquée, votre version est entièrement compatible.
- Si des dates sont indiquées, votre version est obsolète et sera abandonnée à la date spécifiée.
Si votre version est obsolète ou a été abandonnée, vous devez migrer vers une version plus récente pour éviter toute interruption de service. Nous vous recommandons de migrer vers la version la plus récente indiquée dans le calendrier (à l'exception des versions bêta) pour maximiser le temps entre les mises à niveau.
Étape 3 : Mettre à niveau les versions
Pour migrer vers une version plus récente de l'API, vous devrez mettre à jour votre intégration ou obtenir une version mise à jour de votre bibliothèque cliente préférée. Notez que si certaines bibliothèques clientes peuvent fournir une seule compilation fonctionnant avec n'importe quelle version de l'API, d'autres auront des compilations distinctes pour chaque version. La liste suivante fournit des informations générales sur la mise à niveau des bibliothèques clientes et des intégrations 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 à l'aide du 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 à 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 à l'aide du 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. Passez à une version de la bibliothèque cliente qui correspond à la version de l'API que vous souhaitez utiliser.
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 compilations distinctes pour chaque version de l'API Campaign Manager 360, distribuées via Maven. Passez à une version de la bibliothèque cliente qui correspond à la version de l'API que vous souhaitez utiliser.
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. Passez à une version de la bibliothèque cliente qui correspond à la version de l'API que vous souhaitez utiliser.
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 (v1/v2) est compatible avec toutes les versions de l'API Campaign Manager 360. Pour migrer vers une nouvelle version de l'API Campaign Manager 360, mettez à jour la chaîne de version transmise en tant qu'argument au générateur de découverte :
discovery.build('dfareporting', 'v3.4', http=http)
Ruby
La bibliothèque cliente des API Google pour Ruby v0.8 et les versions antérieures sont compatibles avec toutes les versions de l'API Campaign Manager 360. Pour migrer vers une nouvelle version de l'API Campaign Manager 360, mettez à jour la chaîne de version transmise en tant qu'argument au constructeur de service :
service = Google::APIClient::Service.new("dfareporting", "v3.4", { :application_name => "My application", :application_version => '1.0.0', :authorization => authorization } )
REST
Si vous appelez directement l'API à l'aide de HTTPS, mettez à jour le point de terminaison de vos requêtes pour utiliser le nouveau numéro de version de l'API.
Par exemple, lorsque vous migrez de v4 vers v5, vous devez modifier l'URL de base de la manière suivante :
https://dfareporting.googleapis.com/dfareporting/v4/...
https://dfareporting.googleapis.com/dfareporting/v5/...
Étape 4 : Différences entre les versions d'adresse
Les nouvelles versions de l'API sont conçues pour être rétrocompatibles dans la mesure du possible. Toutefois, certaines mises à jour peuvent inclure des modifications importantes qui vous obligent à modifier votre code. Ces modifications sont détaillées dans les notes de version.
Lors de la migration, consultez les notes de version pour chaque version entre votre version actuelle et celle vers laquelle vous effectuez la mise à niveau. Portez une attention particulière aux sections suivantes :
- Nouvelles fonctionnalités : fonctionnalités récemment ajoutées. Ces éléments ne nécessitent pas de modification du code pour la migration.
- Arrêts : fonctionnalités supprimées de l'API. Les fonctionnalités de remplacement sont indiquées lorsqu'elles sont disponibles.
- Problèmes connus : modifications apportées aux fonctionnalités existantes, comme le changement de nom de champs ou de méthodes, ou la modification de la logique de validation.
Si votre application utilise des fonctionnalités listées dans les sections Arrêts de service ou Problèmes connus, vous devrez mettre à jour votre code pour tenir compte de ces modifications.
Rester informé
Consultez régulièrement le blog des développeurs Google Ads pour être informé des nouvelles versions, des abandons et des arrêts de l'API.