Leitfaden für Verkäufer und Käufer zum Generieren von Auktionsberichten der Protected Audience API
Dieser Artikel ist eine technische Referenz zum Erstellen von Berichten für Protected Audience API-Auktionsgewinne, wie in der aktuellen Version des Tests verwendet der Protected Audience API.
Entwicklerleitfaden der Protected Audience API. In der Erläuterung der Protected Audience API finden Sie ausführliche Informationen zu Berichte auf Ereignisebene (temporär):
Sie sind kein Entwickler? Weitere Informationen finden Sie in der Übersicht über die Protected Audience API.
Was wird in der Protected Audience API gemeldet?
Es gibt zwei verfügbare Protected Audience API-Berichte:
- Verkäuferbericht: Der Verkäufer wird über den Gewinner der Anzeigenauktion informiert.
- Käuferbericht: Dieser Bericht ist nur für erfolgreiche Käufer verfügbar und gibt an, dass sie eine Auktion gewonnen haben.
Langfristig sollte der Browser
Berichte zu Auktionsergebnissen für die
Verkäufer und Käufern mit der Private Aggregation API APIs nutzen.
Als temporäres Meldeverfahren auf Ereignisebene
ermöglicht der Code,
reportResult()
für den Verkäufer und reportWin()
für den erfolgreichen Bieter
und rufen Sie die Funktion sendReportTo()
auf. Hierfür wird nur ein Argument verwendet: ein String
Sie stellen eine URL dar, die nach Abschluss der Auktion abgerufen wird. Dabei wird die URL
Informationen auf Ereignisebene,
die gemeldet werden sollen.
API-Funktionen
Verkäufer: reportResult()
Das in decisionLogicUrl
bereitgestellte JavaScript-Code-Snippet des Verkäufers, das auch
scoreAd()
) kann eine reportResult()
-Funktion enthalten, um einen Bericht über die Auktion zu erstellen.
zu erzielen.
reportResult(auctionConfig, browserSignals) {
...
return signalsForWinner;
}
Folgende Argumente werden an diese Funktion übergeben:
auctionConfig
Das an navigator.runAdAuction()
übergebene Auktionskonfigurationsobjekt.
browserSignals
Ein Objekt, das vom Browser erstellt wird und Informationen zur Auktion liefert. Beispiel:
{
'topWindowHostname': 'publisher.example',
'interestGroupOwner': 'https://dsp.example',
'renderUrl': 'https://cdn.example/url-of-winning-creative.wbn',
'bid': <bidValue>,
'desirability': <winningAdScore>
}
Der Rückgabewert dieser Funktion wird als sellerSignals
-Argument für
reportWin()
des erfolgreichen Bieters.
Käufer: reportWin()
Der JavaScript-Code des erfolgreichen Bieters, der auch generateBid()
bereitgestellt hat, kann
eine reportWin()
-Funktion enthalten, um das Auktionsergebnis zu melden.
reportWin(auctionSignals, perBuyerSignals, sellerSignals, browserSignals) {
...
}
Folgende Argumente werden an diese Funktion übergeben:
auctionSignals
und perBuyerSignals
Dieselben Werte, die für das erfolgreiche Gebot an generateBid()
übergeben werden
Bieter.
sellerSignals
Der Rückgabewert von reportResult()
, der dem Verkäufer einen
Informationen an den Käufer weiterzugeben.
browserSignals
Ein Objekt, das vom Browser erstellt wird und Informationen zur Auktion liefert. Beispiel:
{
'topWindowHostname': 'publisher.example',
'seller': 'https://ssp.example',
'interestGroupOwner': 'https://dsp.example',
'interestGroupName': 'custom-bikes',
'renderUrl': 'https://cdn.example/winning-creative.wbn',
'bid': <bidValue>
}
Temporäre Implementierung von Berichten
In Chrome stehen vorübergehend zwei Methoden für Auktionsberichte zur Verfügung:
forDebuggingOnly.reportAdAuctionLoss()
forDebuggingOnly.reportAdAuctionWin()
Diese Methoden verwenden jeweils ein einzelnes Argument: eine URL, die nach der Auktion abgerufen wird.
abgeschlossen. Sie können mehrmals aufgerufen werden, sowohl in scoreAd()
als auch in
generateBid()
mit unterschiedlichen URL-Argumenten.
Chrome sendet nur dann Berichte zu Verlusten und Gewinnen zur Fehlerbehebung, wenn eine Auktion abgeschlossen ist. Wenn wenn eine Auktion abgebrochen wird (z. B. aufgrund einer neuen Navigation), werden keine Berichte generiert werden.
Diese Methoden sind standardmäßig in Chrome verfügbar, wenn Sie unter chrome://settings/adPrivacy
alle APIs zum Datenschutz bei Werbung aktivieren. Wenn Sie
Chrome mit Befehlszeilen-Flags zum Aktivieren der Protected Audience API müssen Sie die Methoden explizit aktivieren, indem Sie das Flag BiddingAndScoringDebugReportingAPI
einfügen. Wenn das Flag nicht aktiviert ist, sind die Methoden zwar verfügbar, führen aber nichts aus.
Alle Protected Audience API-Referenzen
API-Referenzleitfäden sind verfügbar:
- Entwicklerleitfaden für die Protected Audience API
- Käuferleitfaden für Protected Audience zu Interessengruppen und Gebotserstellung.
- Leitfaden für Anzeigenverkäufer zu Protected Audience-Anzeigenauktionen
- Leitfaden zur Berichterstellung für Auktionsergebnisse
- Best Practices für die Latenz bei der Anzeigenauktion von Protected Audience
- Fehlerbehebung bei Protected Audience
In der Erläuterung der Protected Audience API finden Sie auch Details zur Funktionsunterstützung und zu den Einschränkungen.
Nächste Schritte
Wir möchten mit Ihnen ins Gespräch kommen, um eine API zu entwickeln, die für alle funktioniert.
Über die API diskutieren
Wie andere Privacy Sandbox APIs wird auch diese API dokumentiert und öffentlich diskutiert.
Mit der API experimentieren
Sie können Tests zur Protected Audience API durchführen und sich an Diskussionen beteiligen.