生成 Protected Audience API 竞价结果报告

有关如何生成 Protected Audience API 竞价报告的卖方和买方指南。

本文是为下列各项生成相关报告的技术参考。 Protected Audience API 竞价胜出，在实验性功能的当前迭代中使用 Protected Audience API。

全面了解开发者指南 并参阅 Protected Audience API 说明文档，深入讨论 事件级报告（临时）。

不是开发者？请参阅 Protected Audience API 概览。

Protected Audience API 会报告什么内容？

Protected Audience API 报告有两种：

  • 卖方报告：告知卖方广告竞价胜出者。
  • 买方报告：仅向胜出的买方提供，用于了解自己是否赢得了竞价。

我们的长期计划是让浏览器报告 Private Aggregation API API 对卖方和买方进行集成。 作为一种临时的事件级报告机制，用于实施 reportResult()（卖方）和 reportWin()（胜出出价方）可以 调用 sendReportTo() 函数。此方法接受一个参数：字符串 表示在竞价完成后获取的网址，该网址会将 事件级信息。

API 功能

卖家：reportResult()

decisionLogicUrl 中提供的卖方 JavaScript（该 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) {
  ...
}

传递到此函数的参数是：

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 下启用所有 Ad Privacy API 后，Chrome 中会默认提供这些方法。如果您正在运行 Chrome 使用命令行 flag 启用 Protected Audience API，那么您需要通过添加 BiddingAndScoringDebugReportingAPI 标志来明确启用这些方法。如果未启用该标志，这些方法仍然可用，但不执行任何操作。

所有 Protected Audience API 参考文档

以下是 API 参考指南：

Protected Audience API 说明信息还详细介绍了功能支持和限制条件。

后续操作

我们希望与您交流，确保我们构建适合所有人的 API。

讨论 API

与其他 Privacy Sandbox API 一样，此 API 也会记录在案并公开讨论。

使用 API 进行实验

您可以进行实验并参与有关 Protected Audience API 的对话。