Passer de la version 1.1 à la version 2 de l'API Bid Manager

En mars 2022, nous avons publié la version 2 de l'API Bid Manager. Étant donné le de cette nouvelle version, nous prévoyons d'annoncer bientôt la date d'abandon de la v1.1. Mer nous vous recommandons de commencer votre migration de la version 1.1 vers la version 2 dès que possible.

Migrer votre application

La migration de la version 1.1 vers la version 2 nécessite la mise à jour de 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 1.1 à la version 2

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

Identifier les méthodes équivalentes

Pour faire passer vos appels d'API de la version 1.1 à la version 2, vous devez d'abord identifier les méthodes équivalentes de la version 1.1 dans la version 2.

Les noms suivants de tous les services et méthodes ont légèrement changé entre v1.1 et v2:

• Les services Queries et Reports de la version 1.1 sont connus que queries et queries.reports dans la version 2.
• Les méthodes ont été renommées comme suit dans la version 2:

  Nom de la méthode v1.1	Méthode équivalente de la version 2
  Queries.createquery	queries.create
  Queries.deletequery	queries.delete
  Queries.getquery	queries.get
  Queries.listqueries	queries.list
  Queries.runquery	queries.run
  Reports.listreports	queries.reports.list

Mise à jour vers les nouveaux points de terminaison

Une fois que vous avez identifié des méthodes équivalentes, vous devez mettre à jour vos requêtes. Pour Par exemple, pour appeler la méthode queries.getquery avec la version 1.1, vous devez utiliser l'URL suivante:

https://www.googleapis.com/doubleclickbidmanager/v1.1/query/queryId

Pour appeler la méthode équivalente (appelée queries.get) dans la version 2, modifiez la URL de la page suivante:

GET https://doubleclickbidmanager.googleapis.com/v2/queries/queryId

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 API Bid Manager.

Mettre à jour les appels au service queries

• Les champs suivants de la ressource Query, initialement représentés par des Les objets imbriqués ont été modifiés pour utiliser les types d'objets suivants:

  Champ de la version 1.1	Type d'objet v2 équivalent
  metadata	QueryMetadata
  params	Parameters
  params.options	Options
  params.options.pathQueryOptions	PathQueryOptions
  params.options.pathQueryOptions.channelGrouping	ChannelGrouping
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter	PathQueryOptionsFilter
  params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter	PathQueryOptionsFilter
  schedule	QuerySchedule

• Les champs suivants de la ressource Query, initialement représentés par des Les objets "list" ont été remplacés par les listes des nouveaux types d'objets suivants:

  Champ de liste dans la version 1.1	Type d'objet v2
  params.filters[]	FilterPair
  params.options.pathQueryOptions.channelGrouping.rules[]	Rule
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[]	DisjunctiveMatchStatement
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[]	EventFilter
  params.options.pathQueryOptions.pathFilters[]	PathFilter
  params.options.pathQueryOptions.pathFilters[].eventFilters[]	EventFilter

• Les champs suivants de la ressource Query, initialement représentés par sont représentées par des types d'énumération dans la version 2 et incluent les éléments suivants : modifications:
  • L'équivalent v2 de metadata.dataRange utilise désormais Range enum. Lors de la conversion vers cette énumération, la valeur PREVIOUS_HALF_MONTH a été supprimée et que la valeur TYPE_NOT_SUPPORTED a été remplacée par RANGE_UNSPECIFIED
  • metadata.format utilise désormais l'énumération Format. Lors de la conversion à cette énumération, la valeur EXCEL_CSV a été supprimée et la valeur FORMAT_UNSPECIFIED a été ajouté.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match et params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match utilisez maintenant l'énumération Match.
  • params.options.pathQueryOptions.pathFilters[].pathMatchPosition utilise désormais l'énumération PathMatchPosition. En convertissant en pour cette énumération, la valeur PATH_MATCH_POSITION_UNSPECIFIED a été ajoutée.
  • schedule.frequency utilise désormais l'énumération Frequency. Dans conversion dans cette énumération, la valeur FREQUENCY_UNSPECIFIED a été ajoutée.
  • params.type utilise désormais l'énumération ReportType. Dans conversion dans cette énumération, les modifications suivantes ont été apportées:
  • Les valeurs suivantes ont été abandonnées:
    • TYPE_ACTIVE_GRP
    • TYPE_AUDIENCE_PERFORMANCE
    • TYPE_CLIENT_SAFE
    • TYPE_COMSCORE_VCE
    • TYPE_CROSS_FEE
    • TYPE_CROSS_PARTNER
    • TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER
    • TYPE_ESTIMATED_CONVERSION
    • TYPE_FEE
    • TYPE_KEYWORD
    • TYPE_LINEAR_TV_SEARCH_LIFT
    • TYPE_NIELSEN_AUDIENCE_PROFILE
    • TYPE_NIELSEN_DAILY_REACH_BUILD
    • TYPE_NIELSEN_ONLINE_GLOBAL_MARKET
    • TYPE_PAGE_CATEGORY
    • TYPE_PETRA_NIELSEN_DAILY_REACH_BUILD
    • TYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKET
    • TYPE_PIXEL_LOAD
    • TYPE_THIRD_PARTY_DATA_PROVIDER
    • TYPE_TRUEVIEW_IAR
    • TYPE_VERIFICATION
    • TYPE_YOUTUBE_VERTICAL
  • Les valeurs restantes ont toutes été mises à jour pour mieux refléter des valeurs équivalentes dans l'interface utilisateur:

    Valeurs de la version 1.1	Valeur ReportType équivalente
    TYPE_NOT_SUPPORTED	REPORT_TYPE_UNSPECIFIED
    TYPE_GENERAL	STANDARD
    TYPE_INVENTORY_AVAILABILITY	INVENTORY_AVAILABILITY
    TYPE_AUDIENCE_COMPOSITION	AUDIENCE_COMPOSITION
    TYPE_ORDER_ID	FLOODLIGHT
    TYPE_TRUEVIEW	YOUTUBE
    TYPE_NIELSEN_SITE	GRP
    TYPE_PETRA_NIELSEN_AUDIENCE_PROFILE	YOUTUBE_PROGRAMMATIC_GUARANTEED
    TYPE_REACH_AND_FREQUENCY	REACH
    TYPE_REACH_AUDIENCE	UNIQUE_REACH_AUDIENCE
    TYPE_PATH	FULL_PATH
    TYPE_PATH_ATTRIBUTION	PATH_ATTRIBUTION

• Les champs metadata.dataRange, reportDataStartTimeMs reportDataEndTimeMs a été remplacé par des champs range, customStartDate et customEndDate. Les nouveaux champs de date utilisent Date. au lieu de millisecondes depuis l'époque Unix. Ces champs de remplacement ont été déplacés vers l'objet DataRange attribué à la champ dataRange dans QueryMetadata.
• Champs schedule.startTimeMs et schedule.endTimeMs a été remplacé par des champs startDate et endDate dans l'objet QuerySchedule. Les nouveaux champs de date utilisent Date. au lieu de millisecondes depuis l'époque Unix.
• Les champs metadata.running, metadata.reportCount, metadata.googleCloudStoragePathForLatestReport, metadata.googleDrivePathForLatestReport et metadata.latestReportRunTimeMs ont été supprimées. Les informations concernant les derniers rapports générés pour une requête doivent être récupérées à l'aide de la méthode queries.reports.list avec Paramètre de requête orderBy de "key.reportId desc" vers que la demande répertorie en premier les rapports les plus récents.
• Les champs kind, timezoneCode metadata.locale, params.includeInviteData et schedule.nextRunMinuteOfDay ont été supprimées.
• queries.create n'exécute plus automatiquement les requêtes après la création et le paramètre de requête asynchronous a été supprimé. Appeler queries.run après queries.create pour générer des rapports pour de nouvelles requêtes.
• La méthode queries.run a été modifiée comme suit:
  • Le paramètre de requête asynchronous a été remplacé par le synchronous. Le nouveau paramètre de requête fonctionne avec une logique inverse et est considéré comme faux s'il n'est pas spécifié. Donnée Ceci, queries.run génère des rapports de manière asynchrone par défaut dans v2, et non de façon synchrone, qui est le paramètre par défaut dans la version v1.1.
  • Le corps de la requête a été mis à jour pour supprimer le timezoneCode et remplacez dataRange, reportDataStartTimeMs reportDataEndTimeMs champs avec un l'objet DataRange attribué à dataRange.
  • La méthode renvoie l'objet Report obtenu au lieu d'une un corps de réponse vide.
• Le champ kind dans le corps de la réponse queries.list a été supprimé.

Mettre à jour les appels au service reports

• Les champs suivants de la ressource Report représentés initialement par Les objets imbriqués généraux ont été modifiés pour utiliser les types d'objets suivants:

  Champ de la version 1.1	Type d'objet v2 équivalent
  key	ReportKey
  metadata	ReportMetadata
  metadata.status	ReportStatus
  params	Parameters
  params.options	Options
  params.options.pathQueryOptions	PathQueryOptions
  params.options.pathQueryOptions.channelGrouping	ChannelGrouping
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter	PathQueryOptionsFilter
  params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter	PathQueryOptionsFilter

• Les champs suivants de la ressource Report représentés initialement par Les objets de liste générale ont été remplacés par les listes des nouveaux objets suivants types:

  Champ de liste dans la version 1.1	Type d'objet v2
  params.filters[]	FilterPair
  params.options.pathQueryOptions.channelGrouping.rules[]	Rule
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[]	DisjunctiveMatchStatement
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[]	EventFilter
  params.options.pathQueryOptions.pathFilters[]	PathFilter
  params.options.pathQueryOptions.pathFilters[].eventFilters[]	EventFilter

• Les champs suivants de la ressource Report représentés initialement par les chaînes ont changé, leurs champs équivalents dans la version 2 sont donc représentés par de nouvelles types d'énumération et inclure les modifications apportées aux valeurs acceptables:
  • metadata.status.format utilise désormais l'énumération Format. Dans conversion dans cette énumération, la valeur EXCEL_CSV a été supprimée et FORMAT_UNSPECIFIED a été ajouté.
  • metadata.status.state utilise désormais l'énumération State. Dans conversion dans cette énumération, les valeurs QUEUED et STATE_UNSPECIFIED ont ont été ajoutées.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match et params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match utilisez maintenant l'énumération Match.
  • params.options.pathQueryOptions.pathFilters[].pathMatchPosition utilise désormais l'énumération PathMatchPosition. En convertissant en pour cette énumération, la valeur PATH_MATCH_POSITION_UNSPECIFIED a été ajoutée.
  • params.type utilise désormais l'énumération ReportType. Dans conversion vers cette énumération, de nombreuses modifications ont été apportées et sont répertoriées dans dans la section précédente concernant la mise à jour des requêtes.
• Champs metadata.reportDataStartTimeMs et metadata.reportDataEndTimeMs a été remplacé par les champs reportDataStartDate et reportDataEndDate dans ReportMetadata. Les nouveaux champs utilisent Date au lieu de millisecondes depuis l'epoch Unix.
• metadata.status.finishTimeMs a été remplacé par le champ finishTime dans ReportStatus. Ce nouveau champ temporel représente Date et heure en tant que code temporel dans le fichier RFC3339 UTC "Zulu" au lieu de millisecondes depuis l'époque Unix.
• metadata.status.failure et params.includeInviteData champs ont été supprimés.
• Le champ kind dans le corps de la réponse reports.list contient ont été supprimées.

Mettre à jour la logique de gestion des erreurs

Les messages d'erreur de l'API ont été mis à jour dans la version 2. Ces nouveaux messages d'erreur sont plus spécifiques et, dans certains cas, fournissent des informations sur les valeurs de l'attribut Requête API à l'origine de l'erreur. Si l'erreur s'appuie sur un texte de message d'erreur spécifique, généralisez votre erreur avant de migrer vers la v2.