Von der Bid Manager API (Version 1.1 zu Version 2) migrieren

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 aktualisieren Ihre Anwendung, 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 und Reports in Version 1.1 sind bekannt als queries und queries.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:

  v1.1-Feld	Entsprechender V2-Objekttyp
  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

• Die folgenden Felder in der Ressource Query, die ursprünglich durch das allgemeine list-Objekte sind jetzt Listen der folgenden neuen Objekttypen:

  v1.1-Listenfeld	v2-Objekttyp
  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

• Die folgenden Felder in der Ressource Query, ursprünglich dargestellt durch Zeichenfolgen, werden in v2 durch enum-Typen dargestellt und enthalten Folgendes: Änderungen:
  • Im V2-Äquivalent von metadata.dataRange wird jetzt Range verwendet. enum. Bei der Konvertierung in diese Enum wurde der Wert PREVIOUS_HALF_MONTH entfernt und der Wert TYPE_NOT_SUPPORTED wurde geändert zu RANGE_UNSPECIFIED
  • In metadata.format wird jetzt die Enum Format verwendet. Beim Umwandeln zu dieser Enumeration hinzugefügt wurde, wurde der Wert EXCEL_CSV entfernt und der Wert FORMAT_UNSPECIFIED wurde hinzugefügt.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match und params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match verwenden Sie jetzt die Aufzählung Match.
  • params.options.pathQueryOptions.pathFilters[].pathMatchPosition verwendet jetzt PathMatchPosition-Enum Bei der Konvertierung in Für diese Enum wurde der Wert PATH_MATCH_POSITION_UNSPECIFIED hinzugefügt.
  • In schedule.frequency wird jetzt die Enum Frequency verwendet. In bei der Konvertierung in diese Enum wurde der Wert FREQUENCY_UNSPECIFIED hinzugefügt.
  • In params.type wird jetzt die Enum ReportType 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 entsprechenden Werten in der Benutzeroberfläche:

    v1.1-Werte	Entsprechender ReportType-Wert
    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

• Felder metadata.dataRange, reportDataStartTimeMs und reportDataEndTimeMs wurde durch Felder ersetzt range, customStartDate und customEndDate. In den neuen Datumsfeldern wird Date verwendet. -Objekte anstelle von Millisekunden seit Unix-Epoche. Diese Ersatzfelder wurden in das Objekt DataRange verschoben, das der dataRange im Feld QueryMetadata-Objekt
• Felder schedule.startTimeMs und schedule.endTimeMs wurden durch Felder ersetzt startDate und endDate in das Objekt QuerySchedule. In den neuen Datumsfeldern wird Date verwendet. -Objekte anstelle von Millisekunden seit Unix-Epoche.
• Felder metadata.running, metadata.reportCount, metadata.googleCloudStoragePathForLatestReport, metadata.googleDrivePathForLatestReport und metadata.latestReportRunTimeMs wurden entfernt. Informationen zu den zuletzt erstellten Berichten für eine Abfrage sollten werden stattdessen mit der Methode queries.reports.list und der Methode orderBy des Abfrageparameters „key.reportId desc“ in dass in der Anfrage die neuesten Berichte zuerst aufgeführt werden.
• Felder kind, timezoneCode metadata.locale, params.includeInviteData und schedule.nextRunMinuteOfDay wurden entfernt.
• queries.create führt Abfragen nach dem Erstellen nicht mehr automatisch aus und der Suchparameter asynchronous wurde entfernt. Anruf queries.run nach queries.create, um Berichte zu erstellen für neue Abfragen erstellen.
• Die Methode queries.run wurde so aktualisiert:
  • Der asynchronous Suchparameter wurde durch den synchronous verwenden. Der neue Suchparameter arbeitet mit inverser Logik und gilt als falsch, wenn keine Angabe erfolgt. Angegeben Mit queries.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 Sie dataRange, reportDataStartTimeMs reportDataEndTimeMs-Felder mit einem DataRange-Objekt, das dem dataRange.
  • Die Methode gibt das resultierende Report-Objekt anstelle eines Leerer Antworttext.
• Das Feld kind im Antworttext von queries.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:

  v1.1-Feld	Entsprechender V2-Objekttyp
  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

• Die folgenden Felder in der Ressource Report, die ursprünglich durch Allgemeine list-Objekte sind jetzt Listen des folgenden neuen Objekts Typen:

  v1.1-Listenfeld	v2-Objekttyp
  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

• 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:
  • In metadata.status.format wird jetzt die Enum Format verwendet. In bei der Konvertierung in diese Enum wurde der Wert EXCEL_CSV entfernt und FORMAT_UNSPECIFIED wurde hinzugefügt.
  • In metadata.status.state wird jetzt die Enum State verwendet. In haben die Werte QUEUED und STATE_UNSPECIFIED bei der Konvertierung in diese Enumeration wurde hinzugefügt.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match und params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match verwenden Sie jetzt die Aufzählung Match.
  • params.options.pathQueryOptions.pathFilters[].pathMatchPosition verwendet jetzt PathMatchPosition-Enum. Bei der Konvertierung in Für diese Enum wurde der Wert PATH_MATCH_POSITION_UNSPECIFIED hinzugefügt.
  • In params.type wird jetzt die Enum ReportType 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.
• Felder metadata.reportDataStartTimeMs und metadata.reportDataEndTimeMs wurden ersetzt durch Felder reportDataStartDate und reportDataEndDate im ReportMetadata-Objekt. Die neuen Felder verwenden Date-Objekte anstelle von Millisekunden seit Unix-Epoche.
• metadata.status.finishTimeMs wurde ersetzt durch das Feld finishTime im ReportStatus-Objekt Dieses neue Zeitfeld repräsentiert die datetime als Zeitstempel in RFC3339 UTC "Zulu" statt im Format Millisekunden seit Unix-Epoche.
• metadata.status.failure und params.includeInviteData Felder wurden entfernt.
• Das Feld kind im Antworttext von reports.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.