Protected Audience API のオークション結果に関するレポート

Protected Audience API オークション レポートを生成するための販売者と購入者向けガイド。

この記事では、試験運用版の Protected Audience API の現在のイテレーションで使用されている、Protected Audience API オークションの落札に関するレポートの生成に関する技術リファレンスです。

Protected Audience API のライフサイクル全体については、デベロッパー ガイドをご覧ください。また、イベントレベル レポート（一時的）の詳細については、Protected Audience API の説明をご覧ください。

デベロッパー以外の方は、Protected Audience API の概要をご覧ください。

Protected Audience API レポートの内容

Protected Audience API レポートには次の 2 種類があります。

  • 販売者レポート: 広告オークションの落札者を販売者に通知します。
  • 購入者レポート: 落札した購入者のみがオークションに勝ったことを確認できます。

長期計画では、ブラウザが Private Aggregation API API を使用して販売者と購入者のオークション結果を報告できるようにします。一時的なイベントレベルのレポート メカニズムとして、販売者の reportResult() と落札者の reportWin() を実装するコードで sendReportTo() 関数を呼び出すことができます。この引数は 1 つの引数を取ります。この文字列は、オークションの完了後に取得される URL を表す文字列で、報告するイベントレベルの情報をエンコードしています。

API 関数

販売者: reportResult()

decisionLogicUrl（scoreAd() も提供されます）で提供される販売者の JavaScript に 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 では、オークション レポートで一時的に次の 2 つの方法をご利用いただけます。

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

これらのメソッドはそれぞれ、オークションの完了後にフェッチする URL という単一の引数を取ります。これらは、異なる URL 引数を使用して、scoreAd() と generateBid() の両方で複数回呼び出すことができます。

Chrome では、オークションが完了した場合にのみ、デバッグの損失/落札レポートが送信されます。オークションがキャンセルされた場合（新しいナビゲーションなど）、レポートは生成されません。

これらのメソッドは、chrome://settings/adPrivacy で広告プライバシー API をすべて有効にした場合に、Chrome でデフォルトで利用できます。コマンドライン フラグを使用して Chrome を実行し、Protected Audience API を有効にする場合は、BiddingAndScoringDebugReportingAPI フラグを指定してメソッドを明示的に有効にする必要があります。フラグが有効になっていない場合、メソッドは引き続き使用できますが、何も行われません。

すべての Protected Audience API リファレンス

API リファレンス ガイドが提供されています。

Protected Audience API の解説では、機能のサポートと制約に関する詳細も説明しています。

次のステップ

誰もが利用できる API を構築するために、Google は皆様との対話を通じてしたいと考えています。

API についてディスカッションする

他のプライバシー サンドボックス API と同様に、この API はドキュメント化され、一般公開されているです。

API を試す

Protected Audience API に関する会話をテストして参加できます。