Protected Audience API のインタレスト グループの更新 URL を構成して、オーディエンス データを更新する方法について説明します。Protected Audience API のライフサイクル全体については、デベロッパー ガイドをご覧ください。また、ブラウザがインタレスト グループを記録する方法に関する詳細な提案については、Protected Audience API の説明をご覧ください。
デベロッパーでない場合Protected Audience API の概要を参照してください。
Protected Audience API のインタレスト グループ
Protected Audience API のインタレスト グループは、共通の興味や関心を持つユーザーのグループを表し、リマーケティング リストに対応しています。Protected Audience API の各インタレスト グループには所有者がいます。
インタレスト グループのオーナーは、Protected Audience API の広告オークションで買い手として機能します。インタレスト グループのメンバー情報は、ブラウザによってユーザーのデバイスに保存され、ブラウザ ベンダーや他のユーザーと共有されることはありません。
API 関数
使用例
オーディエンス データを定義する方法に関するガイドの例を次に示します。この例では、インタレスト グループを作成し、ブラウザにグループへの参加をリクエストする方法を示しています。
const interestGroup = {
owner: 'https://dsp.example',
name: 'custom-bikes',
biddingLogicUrl: ...,
biddingWasmHelperUrl: ...,
updateUrl: ...,
trustedBiddingSignalsUrl: ...,
trustedBiddingSignalsKeys: ['key1', 'key2'],
userBiddingSignals: {...},
ads: [bikeAd1, bikeAd2, bikeAd3],
adComponents: [customBike1, customBike2, bikePedal, bikeFrame1, bikeFrame2],
};
navigator.joinAdInterestGroup(interestGroup, 7 * kSecsPerDay);
updateUrl は、インタレスト グループの属性を更新する JSON を返す URL を提供します。これは owner と同じオリジンを持つ必要があります。
属性を更新する
updateUrl は、joinAdInterestGroup() に渡されたインタレスト グループ オブジェクトに対応するインタレスト グループ プロパティを定義する JSON を返すウェブサーバーを指定します。
これにより、グループのオーナーはインタレスト グループの属性を定期的に更新できます。現在の実装では、次の属性を変更できます。
biddingLogicUrlbiddingWasmHelperUrltrustedBiddingSignalsUrltrustedBiddingSignalsKeysadspriority
JSON で指定されていないフィールドは上書きされません。JSON で指定されたフィールドのみが更新されます。一方、navigator.joinAdInterestGroup() を呼び出すと、既存のインタレスト グループが上書きされます。
更新はベスト エフォート型であり、次の条件で失敗する可能性があります。
- ネットワーク リクエストのタイムアウト（現在は 30 秒）。
- その他のネットワーク エラー。
- JSON 解析エラー。
更新は 1 日あたり最大 1 回にレート制限されます。
更新に連続して時間がかかりすぎた場合は、更新をキャンセルできます。ただし、キャンセルされた（残りの）更新にレート制限は適用されません。ネットワーク エラーが原因で失敗したアップデートは 1 時間後に再試行され、インターネットから切断されたことが原因で失敗したアップデートは再接続時にすぐに再試行されます。
手動アップデート
現在のフレームのオリジンが所有するインタレスト グループの更新は、navigator.updateAdInterestGroups() を使用して手動でトリガーできます。
レート制限により、更新が頻繁に行われるのを防ぎます。レート制限期間（現在は 1 日）が経過するまで、navigator.updateAdInterestGroups() の呼び出しが繰り返されても何も行われません。
同じインタレスト グループの owner と name に対して navigator.joinAdInterestGroup() が再度呼び出されると、レート制限はリセットされます。
自動更新
オークション用に読み込まれたすべてのインタレスト グループは、オークションの完了後に自動的に更新されます。この更新には、手動更新と同じレート制限が適用されます。
オークションに参加しているインタレスト グループを 1 つ以上持つ各所有者について、オリジンがその所有者と一致する iframe から navigator.updateAdInterestGroups() が呼び出されたかのように動作します。
Protected Audience API のすべてのリファレンス
API リファレンス ガイドが提供されています。
- Protected Audience API のデベロッパー ガイド。
- Protected Audience のインタレスト グループと入札の生成に関する広告購入者向けガイド。
- Protected Audience の広告オークションに関する広告販売者向けガイド。
- オークション結果のレポートに関するガイド
- Protected Audience の広告オークションの遅延に関するベスト プラクティス
- Protected Audience のトラブルシューティング
Protected Audience API の解説では、機能のサポートと制約に関する詳細も説明しています。