Ad Selection API にサインアップする
Ad Selection API は、サード パーティの Cookie を使用せずに、サイトでユーザー関連の広告を提供します。
privacy-preserving-ads
リポジトリの「広告の選択の概要」を参照してください。
Ad Selection API は、次の方法で使用できます。
- サプライサイド プラットフォーム (SSP) を実行している販売者は、API を使用してパブリッシャーに高品質の広告を提供できます。
- 広告キャンペーンの効果を向上させるために API を使用できる需要側プラットフォーム (DSP) を実行しているバイヤー。
Ad Selection API の使用を開始し、エンド ツー エンド フローをテストするには、Ad Selection API の制限付きプレビューにサインアップします。
供給側プラットフォームを運用する販売者または需要側プラットフォームを運用する購入者として、このガイドを使用して次の操作を行います。
- 配信元の試用版に登録して、Ad Selection API の制限付きプレビューにサインアップします。
- 構成証明 JSON ファイルを発行して、API 構成証明を完了します。
- サポートされているクラウド プロバイダーを使用して評価環境を設定します。
- Ad Selection API のドキュメントを表示します。
- User-Defined 関数 (UDF) を準備します。
- サービスを Azure にデプロイします。
- サイトで広告選択 API をテストします。
構成証明登録とアルファ サインアップ
プレビューはいつどこで利用できますか?
130.0.2808.0 以降の Microsoft Edge バージョンでは、欧州経済地域 (EEA) と英国 (英国) の外部にある限定的な開発者オプトイン プレビューで、Ad Selection API がサポートされています。
テスト用のフラグ
開発者マシンの Ad Selection API プラットフォーム機能を変更するには、edge://flags#edge-ad-selection-api
の Ad Selection API テスト フラグを使用します。
Ad Selection API フラグを使用すると、Ad Selection API と関連する次のような機能が有効になります。
- 属性レポート。
- フェンスされたフレーム。
- 共有ストレージ。
- プライベート集計。
サインアップと構成証明の要件とプロセス
アルファ テストに関心がある開発者は、Ad Selection API の配信元試用版に参加できます。 この配信元試用版では、API の使用状況とセキュリティで保護されたコンテナー イメージのデプロイの両方をカバーする、Ad Selection API 機能のエンド ツー エンドのテストが可能になります。
Ad Selection API で使用する最上位ドメインごとに、そのドメインの 配信元試用版登録 フォームに入力し、フォームを送信します。
ドメインの Ad Selection API 配信元試用版にサインアップするには:
新しいウィンドウまたはタブ で、Microsoft Edge で [Ad Selection API Origin 試用版登録 ] を開きます。
[ 今すぐ開始 ] ボタンをクリックします。
使用条件を読んで同意し、[ 次へ ] ボタンをクリックします。 [Ad Selection API Origin 試用版登録] フォームが開きます。
[ ドメイン ] テキスト ボックスに、単一の最上位ドメインを入力します。
配信元試用版は、次のいずれかをサポートするように構成できます。
- サブドメインをサポートせずに、
https://example.com
などの 1 つのドメイン。 -
https://beta.example.com
などの単一のサブドメイン。 -
https://example.com
などのドメインとそのサブドメイン (https://beta.example.com
など)。
末尾のパスとクエリ パラメーターはサポートされていません。
https://example.com/path/new-feature
などの後続パスまたはクエリ パラメーターを持つ URI を入力すると、ルート ドメイン (https://example.com
など) またはサブドメインが登録され、後続のパスやクエリ パラメーターは無視されます。- サブドメインをサポートせずに、
[ サブドメイン サポート ] セクションで、[ はい ] または [ いいえ ] オプション ボタンを選択します。
- サブドメイン (
https://beta.example.com
など) をサポートせずにドメイン (https://example.com
など) で配信元試用版を使用するには、[いいえ] を選択します。 - 配信元試用版を特定のサブドメイン (
https://beta.example.com
など) でのみ使用するには、[いいえ] を選択 します。 - ドメイン (
https://example.com
など) とそのサブドメイン (https://beta.example.com
など) で配信元試用版を使用するには、[ はい] を選択します。
- サブドメイン (
[Email アドレス] テキスト ボックスに、ドメインの有効な開発者連絡先を指定します。
[ 送信 ] ボタンをクリックします。
配信元の試用版トークンが最上位ドメイン用に生成され、送信されます。
ad-selection-attestations.json
という名前のファイルを作成し、/.well-known/
ディレクトリの最上位ドメインでファイルをホストします。 以下に例を示します。https://contoso.example/.well-known/ad-selection-attestations.json
ad-selection-attestations.json
ファイルは、OT トークンを受信してから 30 日以内に発行する必要があります。 構成証明を完了し、コードが Ad Selection API にアクセスできるようにするには、この JSON ファイルをホストして、サポートされている Microsoft Edge クライアントで Ad Selection API をテストする必要があります。
JSON ファイルの例
構成証明 JSON ファイルには、 ad-selection-attestations.json
という名前を付け、次の標準に準拠する必要があります。
ad-selection-attestations.json
ファイルの例を次に示します。
{
"ad_selection_api_attestations": [
{
"attestation_parser_version": "2",
"attestation_version": "2",
"privacy_policy": [
"https://contoso.example/privacy/"
],
"ownership_token": "<Your Unique Token Here>",
"enrollment_site": "https://contoso.example/",
"platform_attestations": [
{
"platform": "edge",
"attestations": {
"ad_selection_api": {
"ServiceNotUsedForIdentifyingUserAcrossSites": true/false
},
"attribution_reporting_api": {
"ServiceNotUsedForIdentifyingUserAcrossSites": true/false
},
"shared_storage_api": {
"ServiceNotUsedForIdentifyingUserAcrossSites": true/false
},
"private_aggregation_api": {
"ServiceNotUsedForIdentifyingUserAcrossSites": true/false
}
}
},
{
"platform": "android",
"attestations": {}
}
]
}
]
}
重要なフィールドと値
ad-selection-attestations.json
ファイルには、生成され、この最上位ドメイン用に送信された配信元試用版トークンが含まれている必要があります。"ownership_token":
は、 Ad Selection API 配信元試用版にこのドメインを登録するときに生成された配信元試用版トークンです。[
"platform_attestations":
] セクションで、"platform":
を"edge"
または"android"
する必要があります。ファイルには、API (Ad Services API に関連付けられている機能) の一覧が含まれている必要があります。 [
"platform_attestations":
] セクションでは、"attestations":
の有効なメンバーを次に示します。-
"ad_selection_api":
- プライベート オークション ロジック用のメイン API。 -
"attribution_reporting_api":
- 属性レポート。 -
"shared_storage_api":
- 共有ストレージ。 -
"private_aggregation_api":
- プライベート集計。 - 要件:
- 各
"..._api":
エントリには、true
またはfalse
値を持つ 1 つのフィールド ("ServiceNotUsedForIdentifyingUserAcrossSites":
) が必要です。true
は、このサービスがサイト間でユーザーを識別するために使用されないことを意味します。false
は、このサービスがサイト間でユーザーを識別するために使用されることを意味します。
- 各
-
Ad Selection API サービスをデプロイする
Ad Selection API は、信頼された実行環境 (TEE) を使用して、データの整合性、データの機密性、およびコードの整合性に対するレベルの保証を提供します。 「コンフィデンシャル コンピューティング: アプリケーションとデータの信頼された実行を Hardware-Based する」を参照してください。 これらのサービスで使用されるデータをセキュリティで保護するには、Ad Selection API によって提供されるサービスを TEE で実行する必要があります。
TEE で実行されている Ad Selection Services は、必要なセキュリティ機能をサポートするクラウド プラットフォームにデプロイする必要があります。 最初は、機密 ACI コンテナーを使用してサービスを Azure にデプロイできます。「Azure Container Instancesの機密コンテナー」を参照してください。
Ad Selection API には、販売者または購入者がデプロイする必要があるさまざまなサービスが用意されています。
サービスをデプロイするためのイメージ
提供されているサービスのイメージ内に User-Defined Functions (UDF) を追加します。 User-Defined Functions では、カスタム ビジネス ロジックを実行できます。 User-Defined Functions は、デプロイされたサービス内のプライベート コンテナーで実行されます。
各イメージは、1 つのサービスを定義します。 一部のイメージには UDF が含まれていないものがあり、完全に定義済みのコードで構成されています。 一部のイメージには、空の本文またはスターター コードを持つ関数として UDF が含まれています。これは、そのサービスに関連する User-Defined Functions です。 これらのイメージ内の User-Defined 関数の本文に、独自のカスタム コードを入力します。
Microsoft は、クラウド プロバイダーにデプロイできる各サービスのイメージを提供します。 これらは、デプロイに使用する必要があるパブリック イメージです。 プライベート オークションを実行できるのは、Microsoft の公式画像のみです。
デプロイ用のイメージ:
- 売り手
- バイヤー
- 販売者と買い手
販売者向けサービス
サービス | 説明 |
---|---|
SellerFrontEnd |
/SelectAd HTTPS エンドポイントを提供します。これは、販売者の信頼されていない広告サービスから、保護対象ユーザーのオークション フローを開始するための要求を受け取ります。 |
競売 |
/ScoreAds エンドポイントを提供します。このエンドポイントは、SellerFrontEnd サービスから要求を受け取り、オークションに参加している入札を含みます。
SellerFrontEnd サービスが勝者を選択するために使用するスコア値で応答します。 |
キー/値 |
SellerFrontEnd サービスから要求を受け取ります。これには、購入者の入札 (ad_render_urls など) からの参照キーが含まれます。 オークションに必要なリアルタイムスコアリングシグナルを返します。 Bring Your Own Service (BYOS) モードで実行されるため、販売者はこのサービスを信頼された実行環境 (TEE) に展開する必要はありません。代わりに、Microsoft によって提供されるイメージを使用できます。 |
バイヤー向けサービス
サービス | 説明 |
---|---|
BuyerFrontEnd |
/GetBids エンドポイントを提供します。このエンドポイントは、SellerFrontEnd サービスから入札フローを開始するための要求を受け取ります。 |
入札 |
/GenerateBids エンドポイントを提供します。このエンドポイントは、BuyerFrontEnd サービスから入札を処理し、入札を生成するための要求を受け取ります。 入札を生成し、勝者を選択し、レンダリングするバナーを選択します。 |
キー/値 | BuyerFrontEnd サービスから要求を受け取り、入札に必要なリアルタイムの購入者データを返します。これは、Interest グループからのルックアップ キーに対応します。 このような要求は、ワークフローごとに 1 回行われます。 Bring Your Own Service (BYOS) モードで実行されます。 |
入札の選択 & キー/値 | 入札サービスから、 入札 に参加できる追加の広告バナー (候補) を選択して返す要求を受け取ります。 入札選択 & キー/値サービスは、入札に必要な追加シグナルを返すこともできます。 入札サービスは、入札選択 & キー/値サービスに複数の要求を送信することも、入札選択 & キー/値サービスがオプションであるため、要求を送信しないことを選択することもできます。 入札選択 & キー/値サービスは、信頼された実行環境 (TEE) にデプロイする必要があります。 |
K-Anonymity | k-匿名性カウンターを収集し、獲得した広告クリエイティブが k-匿名性チェックを通過することを確認します。 |
ユーザー定義関数
販売者と購入者は、デプロイされたサービス内のプライベート コンテナーで実行される User-Defined Functions (UDF) として独自のカスタム コードを提供する必要があります。 これらの User-Defined 関数は、カスタム ビジネス ロジックを実行できます。
各購入者または販売者は、次のような特定のサービスの複数のインスタンスをデプロイできます。
- SellerFrontEnd と Auction。
- BuyerFrontend、 Bidding、 K-Anonymity。
これらのサービスの一部は、User-Defined Functions を定義する JavaScript ワークレットである入力を受け取ります。
売り手向けの User-Defined 関数
UDF | UDF が実行されるサービス | 説明 |
---|---|---|
scoreAd() |
競売 | 各購入者の入札のスコアを生成するか、入札を拒否します。 このスコアは 、SellerFrontEnd サービスによって使用され、すべての購入者の中から勝者を選択します。 |
reportResult() |
SellerFrontEnd | イベント レベルのレポートの場合。 最終的な勝者が選択された後、 SellerFrontEnd サービスで実行されます。 落札者について販売者に通知し、入札額を提供します。 |
購入者向けの User-Defined 関数
UDF | UDF が実行されるサービス | 説明 |
---|---|---|
generateBids() |
入札 | 入札を生成し、表示されるバナーを選択します。 |
reportWin() |
SellerFrontEnd | イベント レベルのレポートの場合。 買い手の入札がオークションに勝った場合、 SellerFrontEnd サービスで実行されます。 オークションに落札したことを購入者に通知し、バナーのレンダリング中や他のクライアント イベントなど、後でトリガーされる通知 URL を生成します。 |
getValues() |
入札の選択 & キー/値 | 購入者がそのサービスを使用している場合は、 入札選択 & キー/価値 サービスで実行されます。 データ参照と選択のカスタム コード実行を許可します。 |
展開ガイド
Ad Selection API サービスを Azure にデプロイするには:
Azure アカウントを作成し、 Microsoft Azure でサブスクリプションを作成します。
[ 機密 ACO コンテナー] オプションを選択します。
新しいウィンドウまたはタブで Terraform デプロイ スクリプト に移動し、Terraform デプロイ スクリプトをダウンロードしてデプロイ ドキュメントを表示します。 手記: ダウンロードしたイメージのハッシュが、ダウンロードしたスクリプトのハッシュと一致していることを確認します。
Terraform スクリプトには、Microsoft によって提供されるパブリック イメージへのリンクが既に含まれています。 必要なサービスを選択し、含まれている
readme.md
の手順に従ってデプロイします。オークションのワークレットの場所など、環境に合わせて特定のフラグを設定します。
すべての前提条件を構成し、すべてのツールをデプロイ用に準備します。
Azure リソースを作成し、デプロイを完了する Terraform スクリプトを実行します。
user-defined-function
(UDF) を含むワークレットを開発し、Ad Selection API サービスを開始します。
Web サイトで広告選択 API を使用する
Ad Selection API の使用を開始するには、販売者と購入者は、ブラウザーが Microsoft Edge のときに実行される Web サイトの JavaScript コードを変更する必要があります。
販売者: プライベート オークションを実行し、関心グループを取得し、レポートを行うには、発行元の Web サイトでコードを更新します。
購入者: 関心グループを作成し、ブラウザーに保存するには、広告パートナーの Web サイトでコードを更新します。 委任メカニズムを使用して、サード パーティ ドメインでのインタレスト グループの作成を制限および許可できます。
使用できる API メソッドの詳細とコード例については、「 Ad Selection API の詳細」を参照してください。
配信元の試用版に関するフィードバックを提供する
Ad Selection API 配信元の試用版に関するフィードバックを提供するには、WICG/privacy-preserving-ads GitHub リポジトリに新しい問題を作成します。
既存の問題を表示するには、 WICG/privacy-preserving-ads リポジトリの [問題] タブに移動します。
新しい問題を送信するには、 新しい問題フォームに移動します。
関連項目
配信元の試用版:
設計および技術ドキュメント:
デプロイ用のイメージ:
- 売り手
- バイヤー
- 販売者と買い手
デプロイ スクリプト:
信頼された実行環境 (TEE):
紺碧: