製作 Protected Audience API 競價結果報表

賣方和買方指南:如何產生 Protected Audience API 競價報表。

本文是產生下列報表的技術參考來源: 如同目前的實驗疊代,Protected Audience API 競價勝出 Protected Audience API。

閱讀開發人員指南,瞭解完整生命週期 ,並參閱 Protected Audience API 說明,深入瞭解 事件層級報表

您不是開發人員嗎?請參閱「Protected Audience API API 總覽」。

Protected Audience API 報表是什麼?

Protected Audience API 有兩種可用的報表:

  • 賣方報表:通知廣告競價勝出者。
  • 買方報表:僅供得標買方查看,用來瞭解他們贏得競價。

我們的長期計劃是讓瀏覽器記錄 使用 Private Aggregation API API 管理賣方和買方 做為暫時性的事件層級回報機制,將導入程式碼 reportResult()對賣方和reportWin()得標者來說, 呼叫 sendReportTo() 函式。這需要使用單一引數:字串 代表競價完成後擷取的網址, 需要回報的事件層級資訊

API 函式

賣家:reportResult()

賣方在 decisionLogicUrl 中提供的 JavaScript (也提供 scoreAd()) 可以包含 reportResult() 函式,回報競價 結果。

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

傳遞至這個函式的引數如下:

auctionConfig

傳遞至 navigator.runAdAuction() 的競價設定物件。

browserSignals

由瀏覽器建構的物件,提供競價相關資訊。 例如:

  {
    'topWindowHostname': 'publisher.example',
    'interestGroupOwner': 'https://dsp.example',
    'renderUrl': 'https://cdn.example/url-of-winning-creative.wbn',
    'bid': <bidValue>,
    'desirability': <winningAdScore>
  }

此函式的傳回值會做為 sellerSignals 引數使用 得標出價方的 reportWin() 函式

買家:reportWin()

得標出價方的 JavaScript (也提供 generateBid()) 可以 加入 reportWin() 函式來回報競價結果。

reportWin(auctionSignals, perBuyerSignals, sellerSignals, browserSignals) {
  ...
}
敬上

傳遞至這個函式的引數如下:

auctionSignalsperBuyerSignals

傳遞給 generateBid() 的值就是勝出者 出價工具

sellerSignals

reportResult() 的傳回值,可讓賣方 可以將資訊傳遞給買方

browserSignals

由瀏覽器建構的物件,提供競價相關資訊。 例如:

{
  'topWindowHostname': 'publisher.example',
  'seller': 'https://ssp.example',
  'interestGroupOwner': 'https://dsp.example',
  'interestGroupName': 'custom-bikes',
  'renderUrl': 'https://cdn.example/winning-creative.wbn',
  'bid': <bidValue>
}

暫時導入報表

Chrome 暫時提供兩種競價報表的方法:

  • forDebuggingOnly.reportAdAuctionLoss()
  • forDebuggingOnly.reportAdAuctionWin()

這些方法都使用單一引數:在競價後要擷取的網址 已完成您可在 scoreAd()generateBid(),使用不同的網址引數。

只有在競價完成時,Chrome 才會傳送偵錯損失/成功報表。如果 取消競價 (例如因為有新導覽) 時,系統不會產生報表 。

當您在 chrome://settings/adPrivacy 中啟用所有廣告隱私權 API 時,Chrome 預設提供這些方法。如果您正在跑步 如果 Chrome 具有用於啟用 Protected Audience API 的指令列旗標,您需要加入 BiddingAndScoringDebugReportingAPI 標記以明確啟用這些方法。如未啟用此旗標,方法仍可使用,但不會有任何動作。

所有 Protected Audience API 參考資料

可用的 API 參考指南如下:

Protected Audience API 說明也提供功能支援和限制的詳細資料。

後續步驟

我們希望與您一起討論,確保我們打造出適合所有人的 API。

討論 API

如同其他 Privacy Sandbox API,這個 API 會記錄並公開討論

使用 API 進行實驗

您可以實驗並參與 Protected Audience API 的討論。