廣告選擇 API 會在你的網站上提供與使用者相關的廣告,且不使用第三方 Cookie。
詳細內容:
簡介
廣告選擇 API 會在你的網站上提供與使用者相關的廣告,且不使用第三方 Cookie。
廣告選擇 API 可用於:
經營供應面平台 (SSP) 的賣家,他們可以利用 API 為出版商提供更高品質的廣告。
使用需求端平台 (DSP) 的買家,利用 API 提升廣告活動的成效。
想開始使用 Ad Selection API 並測試端到端流程,請註冊 Ad Selection API 的有限預覽。
作為操作供給面平台的賣方或需求端平台的買方,請利用本指南:
- 透過註冊原始試用,提供與使用者相關的廣告與廣告選擇 API 有限預覽。
- 透過發布你的證明 JSON 檔案來完成 API 認證。
- 建立一個與支援雲端供應商的評估環境。
- 請參閱廣告選擇 API 文件。
- 準備你的 User-Defined 函式 (UDFs) 。
- 將你的服務部署到 Azure。
- 在你的網站上測試廣告選擇 API。
另請參閱:
- 廣告選擇概覽在倉庫中
privacy-preserving-ads。
認證登記與 alpha 註冊
預覽版何時何地可觀看?
Microsoft Edge 版本從 130.0.2808.0 開始,在歐洲經濟區 () EEA 及英國 (英國) 之外,以有限的開發者選擇預覽方式支援廣告選擇 API。
測試用旗標
要更改開發者電腦上的廣告選擇 API 平台功能,請使用廣告選擇 API 測試標記:edge://flags#edge-ad-selection-api
廣告選擇 API 標誌啟用廣告選擇 API 及相關功能,例如:
- 歸因報告。
- 圍欄框架。
- 共用儲存空間。
- 私人聚合。
註冊與認證要求與流程
有興趣進行 alpha 測試的開發者可加入 Ad Selection API 的原始試用。 此起源試用可從端到端測試廣告選擇 API 功能,涵蓋 API 使用及安全容器映像的部署。
對於你打算在廣告選擇 API 中使用的每個頂層網域,請填寫該網域的 Origin 試用註冊 表單,然後提交表單。
要註冊網域的 廣告選擇API 起源試用:
首先,透過 使用原始試驗來測試實驗性的 API 和功能。
接著建立一個名為
ad-selection-attestations.json的檔案,並將檔案放在頂層網域/.well-known/的目錄中。 例如:https://contoso.example/.well-known/ad-selection-attestations.jsonad-selection-attestations.json該檔案必須在收到 OT 代幣後 30 天內公開。 為了完成你的認證並允許你的程式碼存取廣告選擇API,並使用支援的Microsoft Edge客戶端測試廣告選擇API,必須先架設此JSON檔案。
範例 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) 相關的 API (功能清單。
"platform_attestations":本區的有效成員"attestations":如下:-
"ad_selection_api":- 主要 API,用於私有拍賣邏輯。 -
"attribution_reporting_api":- 歸因報告。 -
"shared_storage_api":- 共用儲存。 -
"private_aggregation_api":- 私人聚合。 - 要求:
- 每個
"..._api":項目必須有一個"ServiceNotUsedForIdentifyingUserAcrossSites":欄位 ,且值為 或truefalse。true這表示此服務不會用於跨站點識別使用者。false這表示這項服務用於跨站點識別使用者。
- 每個
-
部署廣告選擇API服務
廣告選擇 API 採用受信任的執行環境 (TEE) ,提供資料完整性、機密性及程式碼完整性的保證;參見《 機密運算:應用程式與資料 Hardware-Based 可信執行》。 廣告選擇 API 所提供的服務必須在 TEE 中執行,以保護這些服務所使用的資料。
在 TEE 中運行的廣告選擇服務應部署於支援必要安全功能的雲端平台。 最初,服務可透過機密 ACI 容器在 Azure 中部署;詳見 Azure 容器執行個體的機密容器。
廣告選擇 API 提供賣家或買家需要部署的不同服務。
部署服務的映像檔
在提供的服務映像檔中加入您的 User-Defined 函式 (UDFs) 。 User-Defined 函式可以執行自訂的商業邏輯。 User-Defined 函式在已部署服務的私有容器中運行。
每張圖片都代表一種服務。 有些映像檔不包含 UDF,完全由預設程式碼組成。 有些映像包含 UDF,作為帶有空主體或起始碼的函式,這些函式是該服務相關的 User-Defined 函式。 用你自己的自訂程式碼填補這些圖片中 User-Defined 函式的主體。
Microsoft 為每項服務提供映像檔,可部署於雲端供應商。 這些是必須用於部署的公開映像檔。 只有 Microsoft 的官方圖片才能進行私人拍賣。
部署映像檔:
- 賣家
- 買家
- 賣方與買家
賣方服務
| Service | 描述 |
|---|---|
| 賣家前端 | 提供 /SelectAd HTTPS 端點,接收賣方不可信廣告服務的請求,啟動受保護受眾拍賣流程。 |
| 拍賣 | 提供端 /ScoreAds 點,接收來自 SellerFrontEnd 服務的請求,包含參與拍賣的出價。 回覆一個分數值, SellerFrontEnd 服務用來選出得獎者。 |
| 關鍵/價值 | 接收來自 SellerFrontEnd 服務的請求,該服務包含買方出價 (ad_render_urls 如) 的查詢金鑰。 回傳拍賣所需的即時計分訊號。 它以自帶服務 (BYOS) 模式運行,因此賣家不需要在受信任的執行環境 (TEE) 部署此服務,而是可以使用 Microsoft 提供的映像檔。 |
買方服務
| Service | 描述 |
|---|---|
| 買家前端 | 提供端 /GetBids 點,接收 SellerFrontEnd 服務的請求以啟動出價流程。 |
| 叫牌 | 提供端 /GenerateBids 點,接收 BuyerFrontEnd 服務的請求以處理出價並產生出價。 產生出價,選擇得標者,並選擇要呈現的橫幅。 |
| 關鍵/價值 | 接收來自 BuyerFrontEnd 服務的請求,並回傳出價所需的即時買家資料,對應於興趣群組的查詢鍵。 這種請求在每個工作流程中只會發生一次。 以自帶服務 (自帶) 模式運行。 |
| 競標選擇 & 關鍵/價值 | 會收到 競標 服務的請求,要求選擇並返還更多廣告橫幅 () 可參與競標的候選人。 競標選擇 & 關鍵/價值服務也能回傳出競標所需的額外訊號。 競標服務可以向競標選擇 & 關鍵/價值服務發送多個請求,或選擇不發送任何請求,因為競標選擇 & 關鍵/價值服務是可選的。 投標選擇 & 鍵值服務必須部署在受信任的執行環境中, (TEE) 。 |
| K-匿名性 | 收集 k 匿名計數器,並檢查獲勝廣告創作者是否通過 k-匿名性檢定。 |
使用者定義函數
賣方與買方需提供自訂程式碼,作為 UDF) (User-Defined 函數,這些函數可在部署服務內的私人容器中執行。 這些 User-Defined 函式可以執行自訂的商業邏輯。
每位買方或賣方可部署多個特定服務實例,例如:
- 賣家前端 與 拍賣。
- 買家前端、 競標與 K-匿名性。
其中一些服務會接受一個輸入,這是一個定義 User-Defined 函式的 JavaScript 工作組。
User-Defined 賣家的功能
| 聯合民主陣線 | UDF所運行的服務 | 描述 |
|---|---|---|
scoreAd() |
拍賣 | 為每位買家的出價產生分數,或拒絕該出價。 這個分數接著會被 SellerFrontEnd 服務用來從所有買家中選出贏家。 |
reportResult() |
賣家前端 | 用於事件層級報告。 在選出最終得獎者後,會在 SellerFrontEnd 服務中運行。 通知賣方中標者,並提供出價金額。 |
User-Defined 買家的功能
| 聯合民主陣線 | UDF所運行的服務 | 描述 |
|---|---|---|
generateBids() |
叫牌 | 產生出價,並選擇將展示的橫幅。 |
reportWin() |
賣家前端 | 用於事件層級報告。 如果買家出價贏得拍賣,則會運行在 SellerFrontEnd 服務中。 通知買家他們贏得了拍賣,並產生通知網址,這些網址會在橫幅渲染或其他客戶事件時觸發。 |
getValues() |
競標選擇 & 關鍵/價值 | 若買方使用該服務,則 會在競標選擇 & 關鍵/價值 服務中運行。 允許自訂程式碼執行以查找與選取資料。 |
部署指南
要將 Ad Selection API 服務部署到 Azure:
在 Microsoft Azure 建立一個 Azure 帳號並建立訂閱。
選擇機密 ACO 容器 選項。
請在新視窗或分頁中進入 Terraform 部署腳本 ,然後下載部署腳本並查看部署文件。 註: 確保你下載的映像檔雜湊值和你下載腳本中的雜湊值相符。
Terraform 腳本已經包含 Microsoft 提供的公開圖片連結。 選擇所需的服務,並依照包含
readme.md的步驟部署。為你的環境設定特定旗幟,包括拍賣工作坊的位置。
配置所有前置條件並準備所有工具部署。
建立 Azure 資源,並執行完成部署的 Terraform 腳本。
開發包括
user-defined-function(UDF) 的工作檔,並啟動廣告選擇 API 服務。
在你的網站上使用 Ad Selection API
要開始使用 Ad Selection API,賣家和買家需要修改他們網站在瀏覽器為 Microsoft Edge 時執行的 JavaScript 程式碼。
賣家:要進行私人拍賣、尋找興趣團體並進行報告,請在發行商網站上更新你的程式碼。
買家:要建立興趣群組並將其儲存在瀏覽器中,請更新廣告合作夥伴網站上的程式碼。 你可以利用委派機制限制並允許第三方網域建立興趣群組。
欲了解更多可用的 API 方法及查看範例程式碼,請參閱 廣告選擇 API 詳細資訊。
提供關於起源試驗的回饋
為了提供對 Ad Selection API 起源試驗的回饋,請在 WICG/privacy-preserving-ads GitHub 倉庫建立新議題:
要查看現有議題,請前往 WICG/隱私保護廣告倉庫的議題標籤。
若要提交新議題,請前往 新議題表單。
使用條款
請參閱 廣告選擇API使用條款。
資料保護補充說明
請參閱 資料保護附錄中廣告選擇 API。
另請參閱
起源試煉:
設計與技術文件:
部署映像檔:
- 賣家
- 買家
- 賣方與買家
部署腳本:
TEE) (可信執行環境:
Azure: