Im März 2022 haben wir Version 2 der Bid Manager API veröffentlicht. Aufgrund der Veröffentlichung dieser neuen Version planen wir, ein Ablaufdatum für v1.1 bekanntzugeben. Wir empfehlen Ihnen, so schnell wie möglich mit der Migration von Version 1.1 zu Version 2 zu beginnen.
Anwendung migrieren
Für die Migration von v1.1 zu v2 müssen Sie Ihre Endpunkt-URLs aktualisieren, um v2 aufzurufen, und Ihre Anwendung aktualisieren, um funktionsgefährdende Änderungen zu berücksichtigen.
API-Aufrufe von Version 1.1 auf Version 2 aktualisieren
Wenn Sie v2 anstelle von v1.1 verwenden möchten, müssen Sie Ihre Anfragen aktualisieren, um neue v2-Endpunkte zu verwenden.
Äquivalente Methoden identifizieren
Damit Sie Ihre API-Aufrufe von v1.1 auf v2 aktualisieren können, müssen Sie zuerst die entsprechenden v1.1-Methoden in v2 identifizieren.
Die folgenden Namen aller Dienste und Methoden haben sich zwischen v1.1 und v2 geringfügig geändert:
- Die Dienste
Queries
undReports
in Version 1.1 werden in Version 2 alsqueries
undqueries.reports
bezeichnet. - Methoden wurden in Version 2 wie folgt umbenannt:
v1.1-Methodenname Entsprechende V2-Methode 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
Auf neue Endpunkte aktualisieren
Sobald Sie gleichwertige Methoden identifiziert haben, müssen Sie Ihre Anfragen aktualisieren. Um beispielsweise die Methode queries.getquery
mit v1.1 aufzurufen, verwenden Sie die folgende URL:
https://www.googleapis.com/doubleclickbidmanager/v1.1/query/queryId
Zum Aufrufen der entsprechenden Methode in v2, auch queries.get
genannt, aktualisieren Sie die URL so:
GET https://doubleclickbidmanager.googleapis.com/v2/queries/queryId
Wenn Sie Anfragen an die API über eine Clientbibliothek senden, verwenden Sie die neueste Version der Clientbibliothek und aktualisieren Sie Ihre Konfiguration auf Version 2.
Erforderliche Änderungen ausführen
In Version 2 wurden mehrere funktionsgefährdende Änderungen eingeführt. Lesen Sie die folgende Anleitung und nehmen Sie die erforderlichen Änderungen vor, die für Ihre bestehende Verwendung der Bid Manager API relevant sind.
Aufrufe an den Dienst „queries
“ aktualisieren
- Die folgenden Felder in der Ressource
Query
, die ursprünglich durch allgemeine verschachtelte Objekte dargestellt wurden, wurden so geändert, dass sie die folgenden Objekttypen verwenden: - Die folgenden Felder in der Ressource
Query
, die ursprünglich durch allgemeine Listenobjekte dargestellt wurden, wurden in Listen der folgenden neuen Objekttypen geändert: - Die folgenden Felder in der Ressource
Query
, die ursprünglich durch Strings dargestellt wurden, werden in v2 durch Enum-Typen dargestellt. Sie umfassen die folgenden Änderungen:- In der V2-Entsprechung von
metadata.dataRange
wird jetztRange
verwendet. Bei der Konvertierung in diese Enum wurde der WertPREVIOUS_HALF_MONTH
entfernt und der WertTYPE_NOT_SUPPORTED
inRANGE_UNSPECIFIED
geändert. metadata.format
verwendet jetzt die AufzählungFormat
. Bei der Umwandlung in diese Enum wurde der WertEXCEL_CSV
entfernt und der WertFORMAT_UNSPECIFIED
hinzugefügt.- Für
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match
undparams.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match
wird jetzt die EnumMatch
verwendet. params.options.pathQueryOptions.pathFilters[].pathMatchPosition
verwendet jetzt die AufzählungPathMatchPosition
. Bei der Konvertierung in diese Enum wurde der WertPATH_MATCH_POSITION_UNSPECIFIED
hinzugefügt.schedule.frequency
verwendet jetzt die AufzählungFrequency
. Bei der Konvertierung in diese Enum wurde der WertFREQUENCY_UNSPECIFIED
hinzugefügt.params.type
verwendet jetzt die AufzählungReportType
. Bei der Konvertierung in diese Enum wurden folgende Änderungen vorgenommen:- Die folgenden Werte wurden eingestellt:
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
- Die übrigen Werte wurden alle aktualisiert, um die äquivalenten Werte in der UI besser widerzuspiegeln:
v1.1-Werte Entsprechender ReportType
-WertTYPE_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
- In der V2-Entsprechung von
- Die Felder
metadata.dataRange
,reportDataStartTimeMs
undreportDataEndTimeMs
wurden durch die Felderrange
,customStartDate
undcustomEndDate
ersetzt. Die neuen Datumsfelder verwendenDate
-Objekte anstelle von Millisekunden seit der Unix-Epoche. Diese Ersatzfelder wurden in das ObjektDataRange
verschoben, das dem FelddataRange
im ObjektQueryMetadata
zugewiesen ist. - Die Felder
schedule.startTimeMs
undschedule.endTimeMs
wurden durch die FelderstartDate
undendDate
im ObjektQuerySchedule
ersetzt. Die neuen Datumsfelder verwendenDate
-Objekte anstelle von Millisekunden seit der Unix-Epoche. - Die Felder
metadata.running
,metadata.reportCount
,metadata.googleCloudStoragePathForLatestReport
,metadata.googleDrivePathForLatestReport
undmetadata.latestReportRunTimeMs
wurden entfernt. Informationen zu den zuletzt erstellten Berichten einer Abfrage sollten stattdessen mit der Methodequeries.reports.list
und dem AbfrageparameterorderBy
von „key.reportId desc“ abgerufen werden. So wird sichergestellt, dass in der Anfrage die neuesten Berichte zuerst aufgelistet werden. - Die Felder
kind
,timezoneCode
,metadata.locale
,params.includeInviteData
undschedule.nextRunMinuteOfDay
wurden entfernt. queries.create
führt Abfragen nach der Erstellung nicht mehr automatisch aus und der Abfrageparameterasynchronous
wurde entfernt. Rufen Sie nach demqueries.create
queries.run
auf, um Berichte für neue Abfragen zu generieren.- Die Methode
queries.run
wurde so aktualisiert:- Der Abfrageparameter
asynchronous
wurde durch den Abfrageparametersynchronous
ersetzt. Der neue Abfrageparameter arbeitet mit Umkehrlogik und gilt als falsch, wenn er nicht angegeben wird. Daher generiertqueries.run
Berichte in Version 2 standardmäßig asynchron und nicht synchron, was in Version 1.1 die Standardeinstellung ist. - Der Anfragetext wurde aktualisiert, um das Feld
timezoneCode
zu entfernen und die FelderdataRange
,reportDataStartTimeMs
undreportDataEndTimeMs
durch ein ObjektDataRange
zu ersetzen, das dem FelddataRange
zugewiesen ist. - Die Methode gibt das resultierende
Report
-Objekt anstelle eines leeren Antworttexts zurück.
- Der Abfrageparameter
- Das Feld
kind
im Antworttextqueries.list
wurde entfernt.
Aufrufe an den Dienst „reports
“ aktualisieren
- Die folgenden Felder in der Ressource
Report
, die ursprünglich durch allgemeine verschachtelte Objekte dargestellt wurden, wurden so geändert, dass sie die folgenden Objekttypen verwenden: - Die folgenden Felder in der Ressource
Report
, die ursprünglich durch allgemeine Listenobjekte dargestellt wurden, wurden in Listen der folgenden neuen Objekttypen geändert: - Die folgenden Felder in der Ressource
Report
, die ursprünglich durch Strings dargestellt wurden, wurden geändert. Die entsprechenden Felder in V2 werden nun durch neue Enum-Typen dargestellt und enthalten Änderungen an zulässigen Werten:metadata.status.format
verwendet jetzt die AufzählungFormat
. Bei der Konvertierung in diese Enum wurde der WertEXCEL_CSV
entfernt undFORMAT_UNSPECIFIED
hinzugefügt.metadata.status.state
verwendet jetzt die AufzählungState
. Bei der Konvertierung in diese Enum wurden die WerteQUEUED
undSTATE_UNSPECIFIED
hinzugefügt.- Für
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match
undparams.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match
wird jetzt die EnumMatch
verwendet. params.options.pathQueryOptions.pathFilters[].pathMatchPosition
verwendet jetzt die AufzählungPathMatchPosition
. Bei der Konvertierung in diese Enum wurde der WertPATH_MATCH_POSITION_UNSPECIFIED
hinzugefügt.params.type
verwendet jetzt die AufzählungReportType
. Bei der Konvertierung zu dieser Enum wurden zahlreiche Änderungen vorgenommen, die im vorherigen Abschnitt zum Aktualisieren von Dienstaufrufen für Abfragen ausführlich beschrieben sind.
- Die Felder
metadata.reportDataStartTimeMs
undmetadata.reportDataEndTimeMs
wurden im ObjektReportMetadata
durch die FelderreportDataStartDate
undreportDataEndDate
ersetzt. Die neuen Felder verwendenDate
-Objekte anstelle von Millisekunden seit der Unix-Epoche. metadata.status.finishTimeMs
wurde durch das FeldfinishTime
im ObjektReportStatus
ersetzt. Dieses neue Zeitfeld stellt die Datumszeit als Zeitstempel im Format RFC3339 UTC „Zulu“ dar und nicht in Millisekunden seit der Unix-Epoche.- Die Felder
metadata.status.failure
undparams.includeInviteData
wurden entfernt. - Das Feld
kind
im Antworttextreports.list
wurde entfernt.
Fehlerbehandlungslogik für Updates
Fehlermeldungen in der gesamten API wurden in Version 2 aktualisiert. Diese neuen Fehlermeldungen sind spezifischer und enthalten in einigen Fällen Informationen zu den Werten in der API-Anfrage, die zur Rückgabe des Fehlers führen. Wenn Ihre vorhandene Fehlerbehandlungslogik auf bestimmten Fehlermeldungstexten basiert, verallgemeinern Sie Ihre Fehlerbehandlung vor der Migration zu Version 2.