让您的环境做好使用、测试和开发 Topics API Web 应用的准备。
在本地构建和测试
本部分介绍如何设置本地环境,以便以个人开发者的身份试用 Topics API。我们建议您先浏览演示,了解 Topics 的运作方式,然后再深入了解实现。
在浏览器中启用“主题”
如需在您自己的 Chrome 实例中启用 Topics API 以进行本地测试,您有两种选择:
- 启用
chrome://settings/adPrivacy
下的所有广告隐私权 API。 - (推荐)使用 Chromium 标志从命令行运行 Chrome,并使用 Topics API 专用参数根据需要进行配置。通过从命令行运行 Chrome,您可以更精细地控制 Topics 功能。例如,您可以设置 Topics 纪元(API 用于计算用户兴趣的时间范围),并根据需要配置 API 的行为。
主要建议
- 请务必先关闭并停止所有 Chrome 进程,然后再使用相关标志启动新进程。
- 确保在
chrome://settings/adPrivacy
下启用所有广告隐私权 API。 - 如果该 API 未按预期运行,请尝试按照我们的问题排查提示操作。
- 如果您有任何疑问,请查看 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 界面设置的第四个版本。 |
OverridePrivacySandboxSettingsLocalTesting |
已启用 | 启用后,浏览器无需再启用底层设置即可启用 Privacy Sandbox 功能。 |
BrowsingTopicsBypassIPIsPubliclyRoutableCheck |
已停用 | 启用后,在确定网页是否有资格纳入主题计算时,系统会绕过 IP 地址是否可公开路由的检查。 |
BrowsingTopics:number_of_epochs_to_expose |
3 | 用于计算要提供给请求上下文的主题的周期数。浏览器在内部最多会保留 N+1 个时段。 |
BrowsingTopics:time_period_per_epoch |
7 天 - 0 小时 - 0 分钟 - 0 秒 | 每个时段的持续时间。进行调试时,最好将此参数设置为(例如)15 秒,而不是默认的 7 天。 |
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 之前,我们建议您查看这些资源,以熟悉 Topics API。
- 查看开发者文档:
<ph type="x-smartling-placeholder">
- </ph>
- 了解 Topics API 的用途及其在针对用户兴趣投放广告中的作用
- 了解 Topics 在网络上的工作原理。
- 试用演示,并观看主题演示、Colab 和工具演示视频。
- 对演示进行复刻并从您自己的网站运行它们。
- 如需了解更多详情,请参阅 API 说明文档。
- 了解该 API 在支持广告相关性方面发挥的作用,因为未来将会有越来越多的用户无法使用第三方 Cookie。
- 若要接收有关 API 状态变化的通知,请加入开发者邮寄名单,并随时关注最新的 Topics 动态。
- 参与讨论 GitHub 问题或 W3C 调用。
- 如果您遇到不熟悉的术语,请参阅 Privacy Sandbox 术语表。
- 如需详细了解 Chrome 概念(例如 Chrome 标志),请访问 goo.gle/cc,观看短视频和阅读相关文章。
Next steps
Implement Topics
Check out implementation details and code samples for callers to observe and access topics.
Test & go live
Learn how to deploy, test and scale Topics based solutions.