Topics API 設定

準備好環境,即可使用、測試及開發 Topics API 網頁應用程式。

在本機建構及測試

本節說明如何設定本機環境,以個別開發人員身分試用 Topics API。建議您先瀏覽示範,瞭解主題 API 的運作方式,再開始實作。

在瀏覽器中啟用 Topics

如要在自己的 Chrome 執行個體中啟用 Topics API,進行本機測試,有兩種做法:

  1. 啟用 chrome://settings/adPrivacy 下的所有廣告隱私權 API。
  2. (建議) 使用 Chromium 標記,透過指令列執行 Chrome,並使用 Topics API 專屬參數視需要進行設定。從指令列執行 Chrome,即可更精細地控管主題功能。舉例來說,您可以設定主題時代 (API 用來計算使用者興趣的時間範圍),並根據需求設定 API 的行為。

重要建議

  1. 請務必先關閉並停止所有 Chrome 程序,再使用旗標啟動新程序。
  2. 確認「chrome://settings/adPrivacy」下方已啟用所有廣告隱私權 API。
  3. 如果 API 無法正常運作,請參閱疑難排解提示。
  4. 如有任何疑問,請查看說明文件的 GitHub 問題

使用 Chrome 旗標控管 Topics API

Chrome 旗標可以修改 Topics API 的行為。從指令列執行 Chrome,並指定參數以利測試。舉例來說,標頭示範建議使用下列標記:

--enable-features=BrowsingTopics,BrowsingTopicsParameters:time_period_per_epoch/15s/max_epoch_introduction_delay/3s,PrivacySandboxAdsAPIsOverride,PrivacySandboxSettings3,OverridePrivacySandboxSettingsLocalTesting

下表說明每個參數、預設值和用途。

旗標名稱 預設值 說明
BrowsingTopics 已啟用 Topics API 是否已啟用。
PrivacySandboxAdsAPIsOverride 已啟用 啟用廣告 API:Attribution Reporting、Protected Audience、Topics、Fenced Frames。
PrivacySandboxSettings4 已停用 啟用第四版 Privacy Sandbox UI 設定。
OverridePrivacySandboxSettingsLocalTesting 已啟用 啟用後,瀏覽器就不再需要啟用基礎設定,即可啟用 Privacy Sandbox 功能。
BrowsingTopicsBypassIPIsPubliclyRoutableCheck 已停用 啟用後,系統在判斷網頁是否符合主題計算資格時,會略過 IP 位址是否可公開轉送的檢查。
BrowsingTopics:number_of_epochs_to_expose 3 計算主題的週期數,以提供給要求內容。瀏覽器會在內部保留最多 N+1 個紀元。
BrowsingTopics:time_period_per_epoch 7d-0h-0m-0s 每個訓練週期的時間長度。為進行偵錯,建議將此值設為 (例如) 15 秒,而非預設的七天。
BrowsingTopics:number_of_top_topics_per_epoch 5 每個訓練週期計算的主題數。
BrowsingTopics:use_random_topic_probability_percent 5 某個主題在一個週期內,隨機從整個主題分類中傳回的機率。隨機性會與紀元和網站保持一致。
BrowsingTopics:number_of_epochs_of_observation_data_to_use_for_filtering 3 用於篩選呼叫環境主題的 API 使用資料 (即主題觀察) 週期數。
BrowsingTopics:max_number_of_api_usage_context_domains_to_keep_per_topic 1000 每個熱門主題要保留的「觀察對象」內容網域數量上限。目的是要限制使用的記憶體。
BrowsingTopics:max_number_of_api_usage_context_entries_to_load_per_epoch 100000 API 用量情境的每個查詢可從資料庫擷取的項目數量上限。系統會在每個週期的主題計算時間執行一次查詢。目的是要限制記憶體尖峰用量。
BrowsingTopics:max_number_of_api_usage_context_domains_to_store_per_page_load 30 每個網頁載入作業可儲存的 API 用量背景資訊網域數量上限。
BrowsingTopics:config_version 1 編碼 Topics API 設定參數。每個版本號碼只能對應一組設定。更新設定參數而不更新 config_version,通常適用於本機測試,但在某些情況下,可能會導致瀏覽器狀態不一致,甚至造成瀏覽器當機,例如更新 number_of_top_topics_per_epoch
BrowsingTopics:taxonomy_version 1 API 使用的分類版本。

開始導入前的準備工作

開始導入前,建議您先詳閱下列資源,熟悉 Topics API。

  1. 參閱開發人員說明文件:
    1. 瞭解 Topics API 的用途,以及在按照興趣顯示廣告方面的作用
    2. 瞭解 Topics 在網站上的運作方式
    3. 試用示範,並觀看主題示範、colab 和工具的逐步說明影片
    4. 複製範例,然後從自己的網站執行。
    5. 請參閱 API 說明,進一步瞭解詳細資料。
  2. 瞭解在未來越來越多使用者無法使用第三方 Cookie 的情況下,這項 API 如何協助提供相關性高的廣告
  3. 如要接收 API 狀態變更通知,請加入開發人員郵寄清單,並隨時掌握 Topics 的最新消息
  4. GitHub 問題W3C 通話中參與討論。
  5. 如遇到不熟悉的字詞,請參閱 Privacy Sandbox 詞彙表
  6. 如要進一步瞭解 Chrome 概念 (例如 Chrome 旗標),請觀看 goo.gle/cc 提供的短片和文章。

後續步驟

請查看實作詳細資料和程式碼範例,讓呼叫端觀察及存取主題。
瞭解如何部署、測試及擴大使用 Topics 的解決方案。