En mars 2022, nous avons publié la version 2 de l'API Bid Manager. Étant donné le lancement 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
etReports
de la version 1.1 sont connus quequeries
etqueries.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: - 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: - 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: <ph type="x-smartling-placeholder">- </ph>
- L'équivalent v2 de
metadata.dataRange
utilise désormaisRange
enum. Lors de la conversion vers cette énumération, la valeurPREVIOUS_HALF_MONTH
a été supprimée et que la valeurTYPE_NOT_SUPPORTED
a été remplacée parRANGE_UNSPECIFIED
metadata.format
utilise désormais l'énumérationFormat
. Lors de la conversion à cette énumération, la valeurEXCEL_CSV
a été supprimée et la valeurFORMAT_UNSPECIFIED
a été ajouté.params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match
etparams.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match
utilisez maintenant l'énumérationMatch
.params.options.pathQueryOptions.pathFilters[].pathMatchPosition
utilise désormais l'énumérationPathMatchPosition
. En convertissant en pour cette énumération, la valeurPATH_MATCH_POSITION_UNSPECIFIED
a été ajoutée.schedule.frequency
utilise désormais l'énumérationFrequency
. Dans conversion dans cette énumération, la valeurFREQUENCY_UNSPECIFIED
a été ajoutée.params.type
utilise désormais l'énumérationReportType
. Dans conversion dans cette énumération, les modifications suivantes ont été apportées:- Les valeurs suivantes ont été abandonnées:
<ph type="x-smartling-placeholder">
- </ph>
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
équivalenteTYPE_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
- L'équivalent v2 de
- Les champs
metadata.dataRange
,reportDataStartTimeMs
reportDataEndTimeMs
a été remplacé par des champsrange
,customStartDate
etcustomEndDate
. Les nouveaux champs de date utilisentDate
. au lieu de millisecondes depuis l'époque Unix. Ces champs de remplacement ont été déplacés vers l'objetDataRange
attribué à la champdataRange
dansQueryMetadata
. - Champs
schedule.startTimeMs
etschedule.endTimeMs
a été remplacé par des champsstartDate
etendDate
dans l'objetQuerySchedule
. Les nouveaux champs de date utilisentDate
. au lieu de millisecondes depuis l'époque Unix. - Les champs
metadata.running
,metadata.reportCount
,metadata.googleCloudStoragePathForLatestReport
,metadata.googleDrivePathForLatestReport
etmetadata.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éthodequeries.reports.list
avec Paramètre de requêteorderBy
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
etschedule.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êteasynchronous
a été supprimé. Appelerqueries.run
aprèsqueries.create
pour générer des rapports pour de nouvelles requêtes.- La méthode
queries.run
a été modifiée comme suit: <ph type="x-smartling-placeholder">- </ph>
- Le paramètre de requête
asynchronous
a été remplacé par lesynchronous
. 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 remplacezdataRange
,reportDataStartTimeMs
reportDataEndTimeMs
champs avec un l'objetDataRange
attribué àdataRange
. - La méthode renvoie l'objet
Report
obtenu au lieu d'une un corps de réponse vide.
- Le paramètre de requête
- Le champ
kind
dans le corps de la réponsequeries.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: - 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: - 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: <ph type="x-smartling-placeholder">- </ph>
metadata.status.format
utilise désormais l'énumérationFormat
. Dans conversion dans cette énumération, la valeurEXCEL_CSV
a été supprimée etFORMAT_UNSPECIFIED
a été ajouté.metadata.status.state
utilise désormais l'énumérationState
. Dans conversion dans cette énumération, les valeursQUEUED
etSTATE_UNSPECIFIED
ont ont été ajoutées.params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match
etparams.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match
utilisez maintenant l'énumérationMatch
.params.options.pathQueryOptions.pathFilters[].pathMatchPosition
utilise désormais l'énumérationPathMatchPosition
. En convertissant en pour cette énumération, la valeurPATH_MATCH_POSITION_UNSPECIFIED
a été ajoutée.params.type
utilise désormais l'énumérationReportType
. 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
etmetadata.reportDataEndTimeMs
a été remplacé par les champsreportDataStartDate
etreportDataEndDate
dansReportMetadata
. Les nouveaux champs utilisentDate
au lieu de millisecondes depuis l'epoch Unix. metadata.status.finishTimeMs
a été remplacé par le champfinishTime
dansReportStatus
. 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
etparams.includeInviteData
champs ont été supprimés.- Le champ
kind
dans le corps de la réponsereports.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.