Passer de la v2 à la v3

Dernière mise à jour: 31-10-2023

Migrer votre application

Pour passer de la version 2 à la version 3, vous devez mettre à jour vos URL de point de terminaison pour appeler la version 3, ainsi que votre application pour tenir compte des modifications destructives.

Mettre à jour vos appels d'API de la v2 à la v3

Pour utiliser la v3 au lieu de la v2, vous devez mettre à jour vos requêtes afin qu'elles utilisent les nouveaux points de terminaison v3.

Par exemple, pour appeler la méthode advertisers.get avec la version 2, vous devez utiliser l'URL suivante:

GET https://displayvideo.googleapis.com/v2/advertisers/advertiserId

Pour la version 3, modifiez l'URL comme suit:

GET https://displayvideo.googleapis.com/v3/advertisers/advertiserId

Si vous utilisez une bibliothèque cliente pour envoyer des requêtes à l'API, utilisez la version la plus récente de cette bibliothèque et mettez à jour votre configuration pour qu'elle utilise la version 3.

Apporter les modifications requises

Nous apportons un certain nombre de modifications destructives dans la version 3. Consultez les instructions suivantes et apportez les modifications nécessaires en fonction de votre utilisation actuelle de l'API Display & Video 360.

Appels de mise à jour récupérant les ressources YouTube et leur ciblage associé

• Les ressources YoutubeAdGroup et YoutubeAdGroupAd ont été remplacées par AdGroup et AdGroupAd. Ces nouvelles ressources fournissent des informations presque identiques à celles de la version 2, mais peuvent utiliser des noms de champ ou des types d'énumération mis à jour. Dans votre intégration, remplacez vos utilisations des ressources YoutubeAdGroup ou YoutubeAdGroupAd par les ressources AdGroup et AdGroupAd, puis mettez à jour les appels vers les services v2 suivants vers le service v3 correspondant :
  • De advertisers.youtubeAdGroupAds à advertisers.adGroupAds
  • De advertisers.youtubeAdGroups à advertisers.adGroups
  • advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions à advertisers.adGroups.targetingTypes.assignedTargetingOptions
• Les références aux objets YoutubeAndPartnersBiddingStrategy ont été déplacées vers un nouveau champ youtubeAndPartnersBid dans l'objet BiddingStrategy général. Le champ biddingStrategy a été supprimé de l'objet YoutubeAndPartnersSettings. Mettez à jour votre intégration afin de récupérer la stratégie d'enchères pour les éléments de campagne ou les groupes d'annonces YouTube à partir de l'objet BiddingStrategy dans le champ bidStrategy de la ressource LineItem ou AdGroup.
• Dans l'objet YoutubeAndPartnersSettings, le champ thirdPartyMeasurementSettings a été renommé thirdPartyMeasurementConfigs et l'objet YoutubeAndPartnersThirdPartyMeasurementSettings ThirdPartyMeasurementConfigs. Mettez à jour votre intégration pour récupérer les informations de configuration des mesures tierces à l'aide du nouveau champ et du nouveau objet.

Inclure les configurations de facturation requises lors de la création d'annonceurs

Le champ billingConfig est désormais obligatoire dans la ressource Advertiser. Mettez à jour vos requêtes advertisers.create pour vérifier que ce champ est défini. Les informations de facturation par défaut peuvent être récupérées pour le partenaire parent via le nouveau champ billingConfig de la ressource Partner.

Utiliser le nouveau champ pour contrôler le ciblage optimisé

Un nouveau champ booléen enableOptimizedTargeting a remplacé le champ targetingExpansionLevel dans l'objet TargetingExpansionConfig.

Mettre à jour l'intégration des ordres d'insertion pour utiliser le nouveau champ de KPI

Un nouveau champ kpi a remplacé le champ performanceGoal dans la ressource InsertionOrder. Ce nouveau champ utilise un objet Kpi à la place de l'objet PerformanceGoal, ainsi que de nouveaux champs et énumérations.

Suppression des références à des services et champs obsolètes

Plusieurs entités ont été supprimées dans la version 3 pour s'aligner sur les abandons de fonctionnalités passés:

• Le service advertisers.manualTriggers a été supprimé, car les déclencheurs manuels sont obsolètes.
• Le champ billableOutcome a été supprimé de la ressource InsertionOrder, car l'achat en fonction du résultat est obsolète.

Changements supplémentaires

Outre les modifications destructives répertoriées ci-dessus, la version 3 introduit également de nouvelles fonctionnalités.

Vous trouverez les fonctionnalités ajoutées à la v3 après le lancement initial dans nos notes de version.

Gestion des listes d'établissements de proximité

Dans la version 3, vous pouvez gérer entièrement les listes de lieux de proximité, ce qui vous permet d'utiliser le service advertisers.locationLists.assignedLocations pour créer et supprimer des établissements attribués aux ressources TARGETING_LOCATION_TYPE_PROXIMITY LocationList. Les emplacements sont identifiés à l'aide de l'ID de ressources TargetingOption TARGETING_TYPE_POI. Vous pouvez les récupérer à l'aide de targetingTypes.targetingOptions.search.

Possibilité de créer des algorithmes d'enchères personnalisées basés sur des règles

Dans la version 3, vous pouvez créer et récupérer des algorithmes d'enchères personnalisées basés sur des règles à l'aide des services customBiddingAlgorithms, media et customBiddingAlgorithms.rules.

Cette fonctionnalité en version bêta n'est disponible que pour les partenaires figurant sur la liste d'autorisation. S'il ne figure pas sur la liste d'autorisation, votre demande renvoie une erreur.