Von v1 zu v2 migrieren

Letzte Aktualisierung: 06.12.2022

Anwendung migrieren

Bei der Migration von v1 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 auf Version 2 aktualisieren

Wenn Sie v2 anstelle von v1 verwenden möchten, müssen Sie Ihre Anfragen aktualisieren, um neue v2-Endpunkte zu verwenden.

Um beispielsweise die Methode advertisers.get mit v1 aufzurufen, verwenden Sie die folgende URL:

GET https://displayvideo.googleapis.com/v1/advertisers/advertiserId

Aktualisieren Sie die URL für v2 wie folgt:

GET https://displayvideo.googleapis.com/v2/advertisers/advertiserId

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

Wir haben in v2 eine Reihe funktionsgefährdender Änderungen eingeführt. Lesen Sie die folgende Anleitung und nehmen Sie die erforderlichen Änderungen für Ihre vorhandene Verwendung der Display & Video 360 API vor.

Aufrufe für Ausrichtungsmethoden aktualisieren

• Einige Targeting-Typen werden jetzt mithilfe von Enum-Werten anstelle von Targeting-Options-IDs zugewiesen. Beispielsweise erfolgt das Targeting auf Tablets jetzt direkt mit der DEVICE_TYPE_TABLET-DeviceType-Enum anstelle der Targeting-Options-ID aus dem targetingTypes.targetingOptions-Dienst. Die Stringversionen dieser Enums werden im neuen Feld assignedTargetingOptionIdAlias in diesen AssignedTargetingOption-Ressourcen dargestellt und können beim Abrufen oder Löschen des vorhandenen Targetings verwendet werden. Der assignedTargetingOptionId-Wert dieser AssignedTargetingOption-Ressourcen hat sich nicht geändert.

  Aktualisieren Sie Aufrufe, mit denen die folgenden Targeting-Typen verwaltet werden, so, dass sie enum-Werte verwenden:

  • TARGETING_TYPE_AGE_RANGE
  • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
  • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
  • TARGETING_TYPE_DEVICE_TYPE
  • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
  • TARGETING_TYPE_ENVIRONMENT
  • TARGETING_TYPE_EXCHANGE
  • TARGETING_TYPE_GENDER
  • TARGETING_TYPE_HOUSEHOLD_INCOME
  • TARGETING_TYPE_NATIVE_CONTENT_POSITION
  • TARGETING_TYPE_OMID
  • TARGETING_TYPE_PARENTAL_STATUS
  • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
  • TARGETING_TYPE_VIDEO_PLAYER_SIZE
  • TARGETING_TYPE_VIEWABILITY

• Die Methode advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions wurde durch die Methode advertisers.lineItems.bulkEditAssignedTargetingOptions ersetzt.

• Die Methode advertisers.lineItems.bulkListLineItemAssignedTargetingOptions wurde durch die Methode advertisers.lineItems.bulkListAssignedTargetingOptions ersetzt.

• Aktualisieren Sie Aufrufe, die TARGETING_TYPE_PROXIMITY_LOCATION_LIST verwalten, um eine festgelegte Radiusgröße und eine Entfernungseinheit anstelle eines ProximityRadiusRange-Enum-Werts zu verwenden.

• Ausrichtungsmethoden, mit denen Targeting-Optionen für mehrere Targeting-Typen unter einer einzigen übergeordneten Ressource abgerufen oder bearbeitet werden, wurden umbenannt.

  Aktualisieren Sie die Aufrufe der folgenden Methoden, um ihre neuen Namen zu verwenden:

  • advertisers.bulkEditAdvertiserAssignedTargetingOptions bis advertisers.editAssignedTargetingOptions
  • advertisers.bulkListAdvertiserAssignedTargetingOptions bis advertisers.listAssignedTargetingOptions
  • advertisers.campaigns.bulkListCampaignAssignedTargetingOptions bis advertisers.campaigns.listAssignedTargetingOptions
  • advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions zu advertisers.insertionOrders.listAssignedTargetingOptions
  • partners.bulkEditPartnerAssignedTargetingOptions bis partners.editAssignedTargetingOptions

Aufrufe an den Dienst „advertisers.lineItems“ aktualisieren

• Das Feld inventorySourceIds wurde entfernt. Verwalten Sie die Zuweisung der Inventarquelle mit den AssignedTargetingOption-Ressourcen von TARGETING_TYPE_INVENTORY_SOURCE.

• Die folgenden LineItemWarningMessage-Enum-Werte wurden in Version 2 verworfen und werden nicht mehr in LineItem.warningMessages angezeigt:

  • NO_POSITIVE_AUDIENCE_LIST_TARGETED
  • APP_INSTALL_NO_CONVERSION_PIXEL
  • TARGETING_REVOKED_OR_CLOSED_USER_LIST
  • APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY
  • CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS
  • NO_CREATIVE_FOR_TARGETED_DEALS
  • TARGETING_DEPRECATED_GEO_TARGET

• Das Feld triggerId wurde aus dem LineItemFlight-Objekt und der Wert LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER aus dem Enum-Typ LineItemFlightDateType entfernt. In Version 2 wird das Festlegen von Ausgaben für Werbebuchungen basierend auf der Aktivierung manueller Trigger nicht unterstützt.

Aufrufe an den Dienst „customBiddingAlgorithms“ aktualisieren

Die Felder customBiddingAlgorithmState und modelReadiness wurden durch das Feld modelDetails ersetzt, das den Bereitschaftsstatus und die Sperrung des vorhandenen Algorithmusmodells für jeden Werbetreibenden bereitstellt, der Zugriff über eine Liste von CustomBiddingModelDetails-Objekten hat.

Weitere Änderungen

Zusätzlich zu den oben aufgeführten funktionsgefährdenden Änderungen enthält Version 2 neue Funktionen.

Funktionen, die nach der Ersteinführung in Version 2 hinzugefügt wurden, finden Sie in unseren Versionshinweisen.

Lesezugriff auf YouTube-Werbebuchungen

In Version 2 können YouTube-Werbebuchungen und ihre Targeting-Einstellungen mit den Diensten advertisers.lineItems bzw. advertisers.lineItems.targetingTypes.assignedTargetingOptions abgerufen werden. Die API bietet schreibgeschützten Zugriff. Das bedeutet, dass bei versuchten Schreibanfragen an diese Werbebuchungen ein Fehler zurückgegeben wird. YouTube-Werbebuchungen haben einen der folgenden LineItemType-Werte:

• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE

Neue Methoden für bessere Leistung

In Version 2 bietet der advertisers.lineItems-Dienst neue Methoden, die anstelle von aufeinanderfolgenden Anfragen verwendet werden können, um die Leistung zu verbessern und den Kontingentverbrauch zu senken:

• Mit advertisers.lineItems.bulkUpdate können Sie dieselben Feldwerte für mehrere Werbebuchungen festlegen. Derzeit werden nur Aktualisierungen des Felds entityStatus unterstützt.
• Mit advertisers.lineItems.bulkEditAssignedTargetingOptions können Sie dieselben zugewiesenen Targeting-Optionen für mehrere Werbebuchungen hinzufügen oder entfernen.
• Mit advertisers.lineItems.bulkListAssignedTargetingOptions können Sie zugewiesene Targeting-Optionen für mehrere Werbebuchungen auflisten.
• Mit advertisers.lineItems.duplicate können Sie innerhalb desselben Anzeigenauftrags ein Duplikat einer vorhandenen Werbebuchung erstellen und dabei alle Konfigurationen und Targeting-Einstellungen kopieren.

Teilweiser Schreibzugriff für das Targeting von Anzeigenaufträgen

In Version 2 können Sie mit den neuen Methoden create und delete im Dienst advertisers.insertionOrders.targetingTypes.assignedTargetingOptions eine Teilmenge der Targeting-Einstellungen für InsertionOrder-Ressourcen bearbeiten. Die folgenden Targeting-Typen können auf Anzeigenauftragsebene vollständig verwaltet werden:

• TARGETING_TYPE_AGE_RANGE
• TARGETING_TYPE_BROWSER
• TARGETING_TYPE_CATEGORY
• TARGETING_TYPE_CHANNEL
• TARGETING_TYPE_DEVICE_MAKE_MODEL
• TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
• TARGETING_TYPE_ENVIRONMENT
• TARGETING_TYPE_GENDER
• TARGETING_TYPE_KEYWORD
• TARGETING_TYPE_LANGUAGE
• TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
• TARGETING_TYPE_OPERATING_SYSTEM
• TARGETING_TYPE_PARENTAL_STATUS
• TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
• TARGETING_TYPE_VIEWABILITY