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() を使用して手動でトリガーできます。
レート制限によって、更新が頻繁に行われなくなります。navigator.updateAdInterestGroups() を繰り返し呼び出しても、レート制限期間（現在は 1 日）が経過するまで何も実行されません。
同じインタレスト グループ 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 の解説では、機能のサポートと制約に関する詳細も説明しています。