製作 Protected Audience API 競價結果報表

賣方和買方指南：如何產生 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>
  }

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

買家：reportWin()

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

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

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

auctionSignals和perBuyerSignals

向得標出價者傳遞到 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 的討論。