Migrer de v1 à v2

Dernière mise à jour: 06/12/2022

Migrer votre application

La migration de la version 1 vers la version 2 nécessite de mettre à jour vos URL de point de terminaison pour appeler la version 2 et de mettre à jour votre application pour tenir compte des modifications destructives.

Mettre à jour vos appels d'API de la version v1 vers la version v2

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

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

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

Pour la version 2, remplacez l'URL par la suivante:

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

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

Apporter les modifications requises

Nous apportons un certain nombre de modifications non rétrocompatibles dans la version 2. Consultez les instructions suivantes et apportez les modifications requises en fonction de votre utilisation actuelle de l'API Display & Video 360.

Modifier les appels aux méthodes de ciblage

• Certains types de ciblage sont désormais attribués à l'aide de valeurs d'énumération au lieu d'ID d'option de ciblage. Par exemple, les tablettes sont désormais ciblées directement avec l'énumération DeviceType DEVICE_TYPE_TABLET, plutôt que l'ID de l'option de ciblage du service targetingTypes.targetingOptions. Les versions de chaîne de ces énumérations sont représentées dans le nouveau champ assignedTargetingOptionIdAlias de ces ressources AssignedTargetingOption et peuvent être utilisées lors de la récupération ou de la suppression d'un ciblage existant. La valeur assignedTargetingOptionId de ces ressources AssignedTargetingOption n'a pas changé.

  Mettez à jour les appels qui gèrent les types de ciblage suivants pour utiliser des valeurs enum:

  • TARGETING_TYPE_AGE_RANGE
  • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
  • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
  • TARGETING_TYPE_DEVICE_TYPE
  • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
  • TARGETING_TYPE_ENVIRONMENT
  • TARGETING_TYPE_EXCHANGE
  • TARGETING_TYPE_GENDER
  • TARGETING_TYPE_HOUSEHOLD_INCOME
  • TARGETING_TYPE_NATIVE_CONTENT_POSITION
  • TARGETING_TYPE_OMID
  • TARGETING_TYPE_PARENTAL_STATUS
  • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
  • TARGETING_TYPE_VIDEO_PLAYER_SIZE
  • TARGETING_TYPE_VIEWABILITY

• La méthode advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions a été remplacée par la méthode advertisers.lineItems.bulkEditAssignedTargetingOptions.

• La méthode advertisers.lineItems.bulkListLineItemAssignedTargetingOptions a été remplacée par la méthode advertisers.lineItems.bulkListAssignedTargetingOptions.

• Mettez à jour les appels qui gèrent TARGETING_TYPE_PROXIMITY_LOCATION_LIST pour utiliser une taille de rayon et une unité de distance définies au lieu d'une valeur d'énumération ProximityRadiusRange.

• Les méthodes de ciblage qui récupèrent ou modifient des options de ciblage pour plusieurs types de ciblage dans une seule ressource parente ont été rebaptisées.

  Mettez à jour les appels aux méthodes suivantes pour utiliser leurs nouveaux noms:

  • advertisers.bulkEditAdvertiserAssignedTargetingOptions à advertisers.editAssignedTargetingOptions
  • advertisers.bulkListAdvertiserAssignedTargetingOptions à advertisers.listAssignedTargetingOptions
  • advertisers.campaigns.bulkListCampaignAssignedTargetingOptions à advertisers.campaigns.listAssignedTargetingOptions
  • advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions à advertisers.insertionOrders.listAssignedTargetingOptions
  • partners.bulkEditPartnerAssignedTargetingOptions à partners.editAssignedTargetingOptions

Mettre à jour les appels au service advertisers.lineItems

• Le champ inventorySourceIds a été supprimé. Gérez l'attribution de sources d'inventaire à l'aide des ressources AssignedTargetingOption de TARGETING_TYPE_INVENTORY_SOURCE.

• Les valeurs d'énumération LineItemWarningMessage suivantes ont été abandonnées dans la version 2 et ne s'afficheront plus dans LineItem.warningMessages:

  • NO_POSITIVE_AUDIENCE_LIST_TARGETED
  • APP_INSTALL_NO_CONVERSION_PIXEL
  • TARGETING_REVOKED_OR_CLOSED_USER_LIST
  • APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY
  • CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS
  • NO_CREATIVE_FOR_TARGETED_DEALS
  • TARGETING_DEPRECATED_GEO_TARGET

• Le champ triggerId a été supprimé de l'objet LineItemFlight et la valeur LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER a été supprimée du type d'énumération LineItemFlightDateType. La version 2 ne permet pas de définir la dépense des éléments de campagne en fonction de l'activation de déclencheurs manuels.

Mettre à jour les appels au service customBiddingAlgorithms

Les champs customBiddingAlgorithmState et modelReadiness ont été remplacés par le champ modelDetails , qui fournit les états de préparation et de suspension du modèle d'algorithme existant pour chaque annonceur ayant accès à une liste d'objets CustomBiddingModelDetails.

Changements supplémentaires

En plus des modifications non destructives listées ci-dessus, la version 2 introduit également de nouvelles fonctionnalités.

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

Accès en lecture seule aux éléments de campagne YouTube

Dans la version 2, les éléments de campagne YouTube et leurs paramètres de ciblage peuvent être récupérés à l'aide des services advertisers.lineItems et advertisers.lineItems.targetingTypes.assignedTargetingOptions, respectivement. L'API fournit un accès en lecture seule, ce qui signifie que toute tentative de requête d'écriture effectuée sur ces lignes générera une erreur. Les lignes YouTube correspondent à l'une des valeurs LineItemType suivantes:

• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE

Nouvelles méthodes permettant d'améliorer les performances

Dans la version 2, le service advertisers.lineItems fournit de nouvelles méthodes à utiliser à la place des requêtes groupées pour améliorer les performances et réduire la consommation de quota:

• Vous pouvez utiliser advertisers.lineItems.bulkUpdate pour définir les mêmes valeurs de champ pour plusieurs éléments de campagne. Seules les mises à jour du champ entityStatus sont actuellement acceptées.
• Vous pouvez utiliser advertisers.lineItems.bulkEditAssignedTargetingOptions pour ajouter ou supprimer les mêmes options de ciblage attribuées à plusieurs éléments de campagne.
• Vous pouvez utiliser advertisers.lineItems.bulkListAssignedTargetingOptions pour lister les options de ciblage attribuées à plusieurs éléments de campagne.
• Vous pouvez utiliser advertisers.lineItems.duplicate pour créer un double d'un élément de campagne existant dans le même ordre d'insertion, en copiant toutes les configurations et tous les paramètres de ciblage.

Accès en écriture partiel pour le ciblage par ordre d'insertion

Dans la version 2, vous pouvez modifier les paramètres de ciblage d'un sous-ensemble pour les ressources InsertionOrder à l'aide des nouvelles méthodes create et delete du service advertisers.insertionOrders.targetingTypes.assignedTargetingOptions. Les types de ciblage suivants peuvent être entièrement gérés au niveau de l'ordre d'insertion:

• TARGETING_TYPE_AGE_RANGE
• TARGETING_TYPE_BROWSER
• TARGETING_TYPE_CATEGORY
• TARGETING_TYPE_CHANNEL
• TARGETING_TYPE_DEVICE_MAKE_MODEL
• TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
• TARGETING_TYPE_ENVIRONMENT
• TARGETING_TYPE_GENDER
• TARGETING_TYPE_KEYWORD
• TARGETING_TYPE_LANGUAGE
• TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
• TARGETING_TYPE_OPERATING_SYSTEM
• TARGETING_TYPE_PARENTAL_STATUS
• TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
• TARGETING_TYPE_VIEWABILITY