API-Workflows

In dieser Anleitung werden allgemeine API-Workflows zum Erstellen, Stornieren, Abrufen, Aktualisieren und Aushandeln von Deals mit der Deal Sync API beschrieben.

Deal erstellen

  1. Prüfen Sie, ob ein Produkt bereits erstellt wurde. Rufen Sie dazu LIST products mit dem externalDealId Filter auf. Beachten Sie, dass sowohl camelCase externalDealId als auch snake_case external_deal_id im Filterstring unterstützt werden. external_deal_id muss für alle Produkte eindeutig sein.

    GET https://dv360seller.googleapis.com/v1beta1/{parent=exchanges/*/orders/*}/products?filter=externalDealId="{external_deal_id}"

  2. Bestellung erstellen. Der Bestellname wird von DV360 generiert. Wir empfehlen, diese ID für den späteren Abruf in Ihrem System zu speichern.

  3. Produkt unter der Bestellung erstellen. Der Produktname wird von DV360 generiert. Wir empfehlen, diese ID für den späteren Abruf in Ihrem System zu speichern.

Alternativ können Sie LIST mit external_deal_id aufrufen. Der Ressourcenname enthält sowohl die Bestell-ID als auch die Produkt-ID, sodass Sie die übergeordnete Bestellung identifizieren können.

Deal stornieren

  1. Aktualisieren Sie den Bestellstatus auf „CANCELED“ (Storniert). Die Stornierung wird nur unterstützt, wenn die Bestellung noch nicht akzeptiert wurde. „CANCELED“ (Storniert) ist ein Endstatus. Eine Bestellung kann nach der Stornierung nicht mehr reaktiviert werden. Wenn die Bestellung Produkte enthielt, kann ihre external_deal_id nicht wiederverwendet werden.

Details zu einem Deal abrufen

  1. Details zu einer Bestellung abrufen. Der Status wird aktualisiert, sobald der Nutzer die Bestellung akzeptiert, archiviert oder storniert.
  2. Details zu einem Produkt abrufen.

Liste von Deals abrufen

  1. Rufen Sie LIST orders mit einem Statusfilter auf, um alle akzeptierten oder noch nicht akzeptierten Bestellungen zu erhalten.
  2. Rufen Sie LIST products mit dem external_deal_id Filter auf.
  3. Rufen Sie LIST auf für alle Produkte in einer Bestellung.

Deal aktualisieren

  1. Aktualisieren Sie die Bestellung für die Kontaktinformationen des Publishers.
    1. name kann nicht aktualisiert werden (kann nicht in updateMask festgelegt werden). Der Status kann nur über die API auf CANCELED gesetzt werden.
    2. partner_id kann nicht aktualisiert werden.
  2. Produkt für eine bestimmte Aktualisierung der Deal-Laufzeit aktualisieren.
    1. name, externalDealId, transactionType, pricingType, und updateTime können nicht aktualisiert werden.
    2. Für die Aktualisierung von displayName ist keine erneute Akzeptanz durch den Nutzer erforderlich.
    3. Wenn Sie rateDetails oder creativeConfig aktualisieren, ändert sich der Status der übergeordneten Bestellung in PENDING_ACCEPTANCE. DV360-Werbetreibende werden aufgefordert, die neuen Bedingungen auf der Seite „Verhandlungen“ zu akzeptieren, unabhängig davon, ob die vorherige Bestellung bereits akzeptiert wurde.

Prüfen, ob der Nutzer den Deal akzeptiert hat

  1. Rufen Sie die Bestellung ab , wenn Sie den entsprechenden Bestellnamen kennen. Prüfen Sie das Feld status.
  2. Wenn der Bestellname nicht erfasst wurde: Rufen Sie LIST products mit dem Filter „external_deal_id“ auf, ermitteln Sie den Bestellnamen anhand des Produktnamens, und rufen Sie dann die Bestellung ab. Prüfen Sie das Feld status.

Prüfen, ob der Nutzer den Deal konfiguriert hat (nur programmatisch garantiert)

  1. Inventarquelle abrufen. Der Ressourcenname ist exchanges/{exchangeId}/inventorysources/{external_deal_id}. Prüfen Sie den Käufer status.
    1. Reservierungs-Deals:
      1. BUYER_STATUS_ACTIVE: Der Deal wurde akzeptiert und konfiguriert. Die Ausgaben für den Deal beginnen, wenn DV360 Gebotsanfragen erhält, die den Deal-Bedingungen entsprechen. Während der Deal-Konfiguration wird automatisch ein Werbebuchungsposten generiert. Weitere Informationen finden Sie unter Deal Configuration.
      2. BUYER_STATUS_PENDING: Die Bestellung wurde akzeptiert, der Deal aber noch nicht konfiguriert. In diesem Status fallen keine Ausgaben an.
      3. BUYER_STATUS_PAUSED: Der Deal wurde vom Werbetreibenden pausiert. In diesem Status fallen keine Ausgaben an.
    2. Nicht reservierungsbasierte Deals:
      1. BUYER_STATUS_ACTIVE: Der Deal wurde akzeptiert. Die Ausgaben für den Deal beginnen, wenn DV360 passende Gebotsanfragen erhält, ein aktiver Werbebuchungsposten auf den Deal ausgerichtet ist und die Gebotsanfragen den Targeting-Kriterien des Werbebuchungspostens entsprechen. Weitere Informationen finden Sie unter Werbebuchungsposten. (Hinweis: Es gibt keine Verkäufer-API, mit der abgefragt werden kann, ob ein Deal auf Werbebuchungsposten ausgerichtet ist.)
      2. BUYER_STATUS_PENDING: Nicht für nicht reservierungsbasierte Deals anwendbar.
      3. BUYER_STATUS_PAUSED: Der Deal wurde vom Werbetreibenden explizit pausiert. In diesem Status fallen keine Ausgaben an.

Deal nach der Akzeptanz pausieren und die Pausierung aufheben

  1. Aktualisieren Sie den Verkäufer status der Inventarquelle.
    1. Das Pausieren oder Aufheben der Pausierung beendet die Auslieferung des Deals nicht. Wenn ein Verkäufer einen Deal pausiert, wird Werbetreibenden in der DV360-Benutzeroberfläche eine Informationsmeldung angezeigt, die bei der Fehlerbehebung von Deals ohne Ausgaben helfen kann.

Neuverhandlung (Deal nach der Akzeptanz aktualisieren)

Die Neuverhandlung bezieht sich auf Aktualisierungen, die an einem Deal vorgenommen werden, nachdem er vom Käufer akzeptiert wurde. So können Börsen und Käufer die Bedingungen für bestehende Deals anpassen. Beispielsweise kann eine Börse feststellen, dass die Endzeit für einen akzeptierten Deal falsch ist. Die Börse kann Product Patch verwenden, um Aktualisierungen an DV360-Käufer zu senden, bevor die Auslieferung des Deals beginnt.

Zulässige und unzulässige Änderungen

Eine vollständige Aufschlüsselung der Regeln für Deal-Verhandlungen und erneute Verhandlungen finden Sie in den Artikeln der Display &Video 360-Hilfe:

Zurück
Entitätsstruktur
Weiter
Betaprozess