Display & La version 2 de l'API Video 360 s'arrêtera le 3 septembre 2024. Migrez vers la version 3 avant cette date pour éviter une interruption de service.

Cette page a été traduite par l'API Cloud Translation.

Migrer de v1 à v2

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

Migrer votre application

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

Mettre à jour vos appels d'API de la version 1 à la version 2

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

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

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

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

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

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

Apporter les modifications requises

Nous apportons un certain nombre de modifications importantes dans la v2. Passez en revue les éléments suivants instructions et d'apporter les modifications nécessaires à votre utilisation actuelle du Display & l'API Video 360.

Mettre à jour 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 du ciblage ID d'option. Par exemple, les tablettes sont désormais ciblées directement Énumération DEVICE_TYPE_TABLET DeviceType, et non l'identifiant de l'option de ciblage targetingTypes.targetingOptions. Versions de chaîne de ces énumérations sont représentées assignedTargetingOptionIdAlias dans ces les ressources AssignedTargetingOption et peuvent être utilisées lors de la récupération ou en supprimant des critères de ciblage existants. La valeur assignedTargetingOptionId de ces AssignedTargetingOption ressources n'ont pas changé.

Mettez à jour les appels qui gèrent les types de ciblage suivants pour utiliser des valeurs enum:
La méthode advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions a été remplacé par la méthode advertisers.lineItems.bulkEditAssignedTargetingOptions
La méthode advertisers.lineItems.bulkListLineItemAssignedTargetingOptions a été remplacé par la méthode advertisers.lineItems.bulkListAssignedTargetingOptions
Mettre à jour la gestion des appels TARGETING_TYPE_PROXIMITY_LOCATION_LIST d'utiliser une taille de rayon définie et unité de distance au lieu d'une ProximityRadiusRange.
Les méthodes de ciblage qui récupèrent ou modifient les options de ciblage sur plusieurs types de ciblage sous une seule ressource parente ont été renommés.

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

Mettre à jour les appels au service `advertisers.lineItems`

Le champ inventorySourceIds a été supprimé. Gérer Attribution de la source d'inventaire à l'aide de ressources AssignedTargetingOption sur TARGETING_TYPE_INVENTORY_SOURCE.
Les valeurs d'énumération LineItemWarningMessage suivantes ont sont obsolètes dans la version 2 et ne seront plus disponibles 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 de la LineItemFlightDateType. v2 n'est pas compatible en définissant des dépenses pour les éléments de campagne selon l'activation de déclencheurs manuels.

Mettre à jour les appels au service `customBiddingAlgorithms`

customBiddingAlgorithmState et modelReadiness ont été remplacés par modelDetails , qui indique l'aptitude et de suspension de l'algorithme existant pour chaque annonceur qui y a accès via une liste Objets CustomBiddingModelDetails.

Changements supplémentaires

En plus des modifications destructives répertoriées ci-dessus, la version 2 introduit de nouveaux caractéristiques.

Les fonctionnalités ajoutées à la version 2 après le lancement initial sont disponibles dans notre 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 les advertisers.lineItems et advertisers.lineItems.targetingTypes.assignedTargetingOptions respectivement. L'API fournit un accès en lecture seule, ce qui signifie que toute les demandes d'écriture adressées à ces éléments de campagne renverront une erreur. YouTube éléments de campagne seront de l'un des LineItemType suivants :

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

Dans la version 2, le service advertisers.lineItems fournit à la place des requêtes par lot afin d'optimiser des performances et une consommation réduite des quotas:

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 Le champ entityStatus est actuellement accepté.
Vous pouvez utiliser advertisers.lineItems.bulkEditAssignedTargetingOptions pour ajouter ou supprimer les mêmes options de ciblage sur plusieurs lignes éléments.
Vous pouvez utiliser advertisers.lineItems.bulkListAssignedTargetingOptions pour répertorier 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 tous de configuration et de ciblage.

Accès en écriture partiel pour le ciblage des ordres d'insertion

Dans la version 2, vous pouvez modifier un sous-ensemble de paramètres de ciblage pour InsertionOrder des ressources à l'aide des nouveaux create et delete dans la advertisers.insertionOrders.targetingTypes.assignedTargetingOptions Google Cloud. Les types de ciblage suivants peuvent être entièrement gérés au moment de l'insertion au niveau de la commande:

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