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

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:

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:

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