Im März 2022 haben wir Version 2 der Bid Manager API veröffentlicht. In Anbetracht der dieser neuen Version veröffentlichen wir demnächst ein Ablaufdatum für Version 1.1. Mi. empfehlen Ihnen, so bald wie möglich mit der Migration von v1.1 zu v2 zu beginnen.
Anwendung migrieren
Für die Migration von v1.1 zu v2 müssen Ihre Endpunkt-URLs für den Aufruf von v2 aktualisiert werden. Sie müssen Ihre Anwendung aktualisieren, um funktionsgefährdende Änderungen zu berücksichtigen.
API-Aufrufe von v1.1 auf v2 aktualisieren
Wenn Sie v2 anstelle von v1.1 verwenden möchten, müssen Sie Ihre Anfragen auf die neue Version 2 aktualisieren. Endpunkten.
Äquivalente Methoden identifizieren
Um Ihre API-Aufrufe von v1.1 auf v2 zu aktualisieren, müssen Sie zunächst die entsprechenden Methoden aus Version 1.1 in Version 2.
Die folgenden Namen aller Dienste und Methoden haben sich zwischen v1.1 und v2:
- Die Dienste
Queries
undReports
in Version 1.1 sind bekannt alsqueries
undqueries.reports
in Version 2. - In v2 wurden die Methoden wie folgt umbenannt:
v1.1-Methodenname Äquivalente 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 die äquivalenten Methoden identifiziert haben, müssen Sie Ihre Anfragen aktualisieren. Für
Um beispielsweise die Methode queries.getquery
mit v1.1 aufzurufen, verwenden Sie
die folgende URL:
https://www.googleapis.com/doubleclickbidmanager/v1.1/query/queryId
Um die entsprechende Methode in Version 2, queries.get
, aufzurufen, aktualisieren Sie die
URL zu Folgendem:
GET https://doubleclickbidmanager.googleapis.com/v2/queries/queryId
Wenn Sie eine Clientbibliothek verwenden, um Anfragen an die API zu senden, verwenden Sie die aktuelle Version der Clientbibliothek und aktualisieren Sie Ihre Konfiguration für die Verwendung von v2.
Erforderliche Änderungen ausführen
Version 2 enthält eine Reihe funktionsgefährdender Änderungen. Überprüfen Sie Folgendes und nehmen Sie die erforderlichen Änderungen vor, die für Ihre Nutzung des Bid Manager API
Aufrufe des Dienstes queries
aktualisieren
- Die folgenden Felder in der Ressource
Query
, die ursprünglich durch das allgemeine Verschachtelte Objekte verwenden jetzt folgende Objekttypen: - Die folgenden Felder in der Ressource
Query
, die ursprünglich durch das allgemeine list-Objekte sind jetzt Listen der folgenden neuen Objekttypen: - Die folgenden Felder in der Ressource
Query
, ursprünglich dargestellt durch Zeichenfolgen, werden in v2 durch enum-Typen dargestellt und enthalten Folgendes: Änderungen: <ph type="x-smartling-placeholder">- </ph>
- Im V2-Äquivalent von
metadata.dataRange
wird jetztRange
verwendet. enum. Bei der Konvertierung in diese Enum wurde der WertPREVIOUS_HALF_MONTH
entfernt und der WertTYPE_NOT_SUPPORTED
wurde geändert zuRANGE_UNSPECIFIED
- In
metadata.format
wird jetzt die EnumFormat
verwendet. Beim Umwandeln zu dieser Enumeration hinzugefügt wurde, wurde der WertEXCEL_CSV
entfernt und der WertFORMAT_UNSPECIFIED
wurde hinzugefügt. params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match
undparams.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match
verwenden Sie jetzt die AufzählungMatch
.params.options.pathQueryOptions.pathFilters[].pathMatchPosition
verwendet jetztPathMatchPosition
-Enum. Bei der Konvertierung in Für diese Enum wurde der WertPATH_MATCH_POSITION_UNSPECIFIED
hinzugefügt.- In
schedule.frequency
wird jetzt die EnumFrequency
verwendet. In bei der Konvertierung in diese Enum wurde der WertFREQUENCY_UNSPECIFIED
hinzugefügt. - In
params.type
wird jetzt die EnumReportType
verwendet. In wurden die folgenden Änderungen vorgenommen: - Die folgenden Werte wurden eingestellt:
<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
- Die verbleibenden Werte wurden aktualisiert, um die
entsprechende Werte in der Benutzeroberfläche:
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
- Im V2-Äquivalent von
- Felder
metadata.dataRange
,reportDataStartTimeMs
undreportDataEndTimeMs
wurde durch Felder ersetztrange
,customStartDate
undcustomEndDate
. In den neuen Datumsfeldern wirdDate
verwendet. -Objekte anstelle von Millisekunden seit Unix-Epoche. Diese Ersatzfelder wurden in das ObjektDataRange
verschoben, das derdataRange
im FeldQueryMetadata
-Objekt - Felder
schedule.startTimeMs
undschedule.endTimeMs
wurden durch Felder ersetztstartDate
undendDate
in das ObjektQuerySchedule
. In den neuen Datumsfeldern wirdDate
verwendet. -Objekte anstelle von Millisekunden seit Unix-Epoche. - Felder
metadata.running
,metadata.reportCount
,metadata.googleCloudStoragePathForLatestReport
,metadata.googleDrivePathForLatestReport
undmetadata.latestReportRunTimeMs
wurden entfernt. Informationen zu den zuletzt erstellten Berichten für eine Abfrage sollten werden stattdessen mit der Methodequeries.reports.list
und der MethodeorderBy
des Abfrageparameters „key.reportId desc“ in dass in der Anfrage die neuesten Berichte zuerst aufgeführt werden. - Felder
kind
,timezoneCode
metadata.locale
,params.includeInviteData
undschedule.nextRunMinuteOfDay
wurden entfernt. queries.create
führt Abfragen nach dem Erstellen nicht mehr automatisch aus und der Suchparameterasynchronous
wurde entfernt. Anrufqueries.run
nachqueries.create
, um Berichte zu erstellen für neue Abfragen erstellen.- Die Methode
queries.run
wurde so aktualisiert: <ph type="x-smartling-placeholder">- </ph>
- Der
asynchronous
Suchparameter wurde durch densynchronous
verwenden. Der neue Suchparameter arbeitet mit inverser Logik und gilt als falsch, wenn keine Angabe erfolgt. Angegeben Mitqueries.run
werden Berichte standardmäßig asynchron in v2 und nicht synchron (Standardeinstellung in v1.1). - Der Anfragetext wurde aktualisiert, um Folgendes zu entfernen:
timezoneCode
und ersetzen SiedataRange
,reportDataStartTimeMs
reportDataEndTimeMs
-Felder mit einemDataRange
-Objekt, das demdataRange
. - Die Methode gibt das resultierende
Report
-Objekt anstelle eines Leerer Antworttext.
- Der
- Das Feld
kind
im Antworttext vonqueries.list
wurde entfernt.
Aufrufe des Dienstes reports
aktualisieren
- Die folgenden Felder in der Ressource
Report
, die ursprünglich durch Allgemeine verschachtelte Objekte verwenden jetzt die folgenden Objekttypen: - Die folgenden Felder in der Ressource
Report
, die ursprünglich durch Allgemeine list-Objekte sind jetzt Listen des folgenden neuen Objekts Typen: - Die folgenden Felder in der Ressource
Report
, die ursprünglich durch Zeichenfolgen geändert, sodass ihre äquivalenten Felder in v2 durch neue enum-Typen und Änderungen an zulässigen Werten: <ph type="x-smartling-placeholder">- </ph>
- In
metadata.status.format
wird jetzt die EnumFormat
verwendet. In bei der Konvertierung in diese Enum wurde der WertEXCEL_CSV
entfernt undFORMAT_UNSPECIFIED
wurde hinzugefügt. - In
metadata.status.state
wird jetzt die EnumState
verwendet. In haben die WerteQUEUED
undSTATE_UNSPECIFIED
bei der Konvertierung in diese Enumeration wurde hinzugefügt. params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match
undparams.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match
verwenden Sie jetzt die AufzählungMatch
.params.options.pathQueryOptions.pathFilters[].pathMatchPosition
verwendet jetztPathMatchPosition
-Enum. Bei der Konvertierung in Für diese Enum wurde der WertPATH_MATCH_POSITION_UNSPECIFIED
hinzugefügt.- In
params.type
wird jetzt die EnumReportType
verwendet. In bei der Konvertierung in diese Aufzählung wurden zahlreiche Änderungen vorgenommen, die in im vorherigen Abschnitt zum Aktualisieren von Dienstaufrufen für Abfragen.
- In
- Felder
metadata.reportDataStartTimeMs
undmetadata.reportDataEndTimeMs
wurden ersetzt durch FelderreportDataStartDate
undreportDataEndDate
imReportMetadata
-Objekt. Die neuen Felder verwendenDate
-Objekte anstelle von Millisekunden seit Unix-Epoche. metadata.status.finishTimeMs
wurde ersetzt durch das FeldfinishTime
imReportStatus
-Objekt Dieses neue Zeitfeld repräsentiert die datetime als Zeitstempel in RFC3339 UTC "Zulu" und nicht im Format Millisekunden seit Unix-Epoche.metadata.status.failure
undparams.includeInviteData
Felder wurden entfernt.- Das Feld
kind
im Antworttext vonreports.list
enthält entfernt wurden.
Fehlerbehandlungslogik aktualisieren
Die Fehlermeldungen in der API wurden in Version 2 aktualisiert. Diese neuen Fehlermeldungen sind spezifischer und liefern in einigen Fällen Informationen zu den Werten API-Anfrage, durch die der Fehler zurückgegeben wird. Wenn Ihr aktueller Fehler Die Verarbeitungslogik basiert auf einem bestimmten Fehlermeldungstext, verallgemeinern Sie den Fehler vor der Migration zu v2 behandelt.