Browserbasierte Auktion mit einem einzelnen Verkäufer durchführen

In diesem Dokument finden Sie eine allgemeine Übersicht zur Durchführung einer Auktion mit Protected Audience-Daten für einen einzelnen Verkäufer, wie in der aktuellen Version von der Protected Audience API. Eine Auktion mit einem einzelnen Verkäufer als Teil einer komplexeren Auktion mit mehreren Verkäufern. In dieser wird die Auktion eines einzelnen Verkäufers als „Komponentenauktion“ bezeichnet. können Anzeigenkandidaten für die Top-Level-Auktion bereitstellen. mit mehreren Verkäufern teilnehmen können.

Im Entwicklerleitfaden finden Sie Informationen zum gesamten Lebenszyklus der Protected Audience API. und in der Erläuterung zur Protected Audience API finden Sie eine ausführliche wie Verkäufer On-Device-Auktionen durchführen,

Sechs Phasen einer Protected Audience API-Anzeigenauktion

<ph type="x-smartling-placeholder">
</ph> <ph type="x-smartling-placeholder"></ph> Sechs Phasen einer Protected Audience API-Anzeigenauktion
In diesem Diagramm werden die einzelnen Phasen einer Protected Audience API-Anzeigenauktion dargestellt.
  1. Ein Nutzer besucht eine Website, auf der Anzeigen ausgeliefert werden.
  2. Mit dem Verkäufercode wird navigator.runAdAuction() ausgeführt. Damit wird angegeben, Werbefläche zum Verkauf steht und wer Gebote abgeben kann. Verkäufer müssen außerdem ein Skript für jedes Gebot, scoreAd().
  3. Mit dem Code des eingeladenen Käufers wird ein Gebot und die URL für eine relevante Anzeige generiert. Creative und andere Daten. Das Gebotsskript kann Echtzeitdaten abfragen, etwa das verbleibende Kampagnenbudget, Schlüssel/Wert-Dienst.
  4. Über den Code des Verkäufers wird jedes Gebot bewertet und das erfolgreiche Gebot ermittelt. Diese Logik verwendet die Gebotswert und andere Daten geben Aufschluss darüber, wie wichtig ein Gebot ist. Anzeigen, die unschlagbar sind wird der kontextbezogene Gewinner abgelehnt. Der Verkäufer kann eine eigene Schlüssel/Wert-Dienst für Echtzeitdaten
  5. Die erfolgreiche Anzeige wird als opaker Wert zurückgegeben, der in einer Fened Frame Sowohl der Verkäufer als auch kann der Publisher diesen Wert nicht sehen.
  6. Die Auktion wird dem Verkäufer und den erfolgreichen Käufern gemeldet.

Eine Auktion kann stattfinden, wenn ein Nutzer eine Seite mit einer Anzeige aufruft. Auktionen können im Voraus durchgeführt werden, damit das Creative bereit ist, wenn die Anzeige sichtbar ist.

Verkäufer initiieren die Anzeigenauktion und bewerten mögliche Anzeigen anhand der benutzerdefinierten Logik. als scoreAd()-Funktion und sind für die Berichterstellung der Ergebnisse der an sich selbst und an den erfolgreichen Käufer versteigert. Verkäufer können außerdem Publisher-Regeln durchzusetzen und mit ihren scoreAd() nach Anzeigenqualität zu filtern .

Ein Verkäufer kann sich auf Folgendes beziehen:

  • Content-Publisher, die Anzeigeninhalte auf ihrer Website selbst hosten
  • Supply-Side-Plattformen (SSP), Zusammenarbeit mit dem Anzeigen-Publisher und Bereitstellung anderer Dienste
  • Skripts von Drittanbietern, die im Auftrag eines Publishers die Teilnahme an Anzeigenauktionen ermöglichen

Voraussetzungen für die Durchführung einer Auktion

Ein Verkäufer muss für die Durchführung einer Auktion zwei JavaScript-Funktionen definieren:

  • scoreAd(), die einen Anzeigenkandidaten bewertet
  • reportResult(), über die das Ergebnis der Auktion an den Verkäufer gesendet wird

Diese Skripts müssen von einem einzigen Endpunkt bereitgestellt werden, der dem Verkäufer gehört.

scoreAd()

Ein Verkäufer muss eine scoreAd()-Funktion definieren, die von einem Endpunkt bereitgestellt wird die ihnen gehören. Der Endpunkt wird in der Auktionskonfiguration als decisionLogicUrl Die Funktion scoreAd() hat die folgende Signatur:

scoreAd(
  adMetadata,
  bid,
  auctionConfig,
  trustedScoringSignals,
  browserSignals,
  directFromSellerSignals)

Die scoreAd()-Parameter sind:

  • adMetaData, was beliebige Metadaten zur betreffenden Anzeige ist. vom Käufer bereitgestellt werden. Dies ist ein serialisierbares JSON-Objekt, das Verkäufer und muss die Struktur definiert und vereinbart werden.
  • bid, der ein numerischer Wert für das Gebot ist.
  • auctionConfig: Die Auktionskonfiguration, die zur Ausführung der Auktion verwendet wird.
  • trustedScoringSignals, das sind Signale, die zum Zeitpunkt der Auktion vom Schlüssel/Wert-Server des Verkäufers. Die Plattform verwendet die renderUrl des mögliche Anzeige als Schlüssel für diese Suche verwendet.
  • browserSignals, wobei es sich um ein vom Browser erstelltes Objekt handelt, einschließlich die dem Browser bekannt sind und über das Auktionsskript des Verkäufers die Sie überprüfen möchten.
  • directFromSellerSignals ist ein Objekt, das die folgenden Felder enthalten kann: ** sellerSignals: Wie auctionConfig.sellerSignals, aber übergeben mit dem directFromSellerSignals-Mechanismus. ** auctionSignals: Wie auctionConfig.auctionSignals, aber übergeben mit dem directFromSellerSignals-Mechanismus.

Im Folgenden finden Sie ein Beispiel für browserSignals. Beachten Sie, dass der renderUrl der mögliche Anzeige über diese Signale verfügbar:

{ 'topWindowHostname': 'www.example-publisher.com',
  'interestGroupOwner': 'https://www.example-buyer.com',
  'renderURL': 'https://cdn.com/render_url_of_bid',
  'renderSize': {width: 100, height: 200}, /* if specified in the bid */
  'adComponents': ['https://cdn.com/ad_component_of_bid',
                   'https://cdn.com/next_ad_component_of_bid',
                   ...],
  'biddingDurationMsec': 12,
  'bidCurrency': 'USD', /* bidCurrency returned by generateBid, or '???' if none */
  'dataVersion': 1, /* Data-Version value from the trusted scoring signals server's response */
}

reportResult()

Ein Verkäufer muss eine reportResult()-Funktion definieren, die von einem Endpunkt, den sie besitzen. Der Endpunkt wird in der Auktionskonfiguration angegeben. als decisionLogicUrl. Die Funktion reportResult() hat Folgendes: Signatur:

reportResult(auctionConfig, browserSignals) {
  ...
  return signalsForWinner;
}

Die reportResult()-Parameter sind:

  • auctionConfig: Die Auktionskonfiguration, die zur Ausführung der Auktion verwendet wird.
  • browserSignals, wobei es sich um ein vom Browser erstelltes Objekt handelt, einschließlich die dem Browser bekannt sind und über das Auktionsskript des Verkäufers die Sie überprüfen möchten. Dies ist das gleiche Objekt, das an die Funktion scoreAds() übergeben wird.

reportResult() gibt signalsForWinner zurück, ein beliebiges JSON-Objekt. das an die Berichtsfunktion des Käufers übergeben wird, der die Auktion gewonnen hat. Dazu gehören alle relevanten Informationen, die der Verkäufer über die Auktion für die Berichterstellung benötigt.

Protected Audience API-Auktion durchführen

Verkäufer müssen vier Hauptschritte ausführen, um eine Auktion durchzuführen. Beachten Sie, dass diese Schritte davon aus, dass der Verkäufer einen Endpunkt eingerichtet hat, um den erforderlichen JavaScript-Code zurückzugeben die zuvor in diesem Leitfaden erwähnt wurden.

  1. Konfigurieren Sie die Auktion. Dieser Schritt umfasst das Erstellen eines auctionConfig-Objekts. So kann der Verkäufer angeben, welche Käufer am Auktion sowie alle Signale an, die während der Gebotsabgabe oder die Anzeigenbewertung.
  2. Starten Sie die Auktion, indem Sie navigator.runAdAuction() aufrufen und den Parameter Konfiguration erstellt haben. Dadurch wird die Käuferkette initiiert Gebote generieren und dann bewerten. Das Endergebnis dieses Schritts ist ein Anzeigenkandidat. das gerendert werden kann, um eine Anzeige auszuliefern.
  3. Rendern Sie die erfolgreiche Anzeige in einem abgegrenzten Frame oder iFrame.
  4. Melden Sie das Ergebnis der Auktion. Es gibt eine Funktion, navigator.sendReportTo(), wodurch die Berichterstellung gestartet wird. Der Verkäufer wird immer erhalten Sie einen Bericht zu den Auktionsergebnissen. Nur der Käufer, der die Auktion gewonnen hat erhält einen Bericht. Hierfür wird die zuvor beschriebene reportResult() des Verkäufers verwendet in diesem Leitfaden, um Daten an ihren Server zu melden.