相关性和衡量统一源试用

Topics、Fenced Frames 和 Shared Storage。 keywords: product:PrivacySandbox, docType:Guide, topicAdSetup, contentTypeSolution, category:Web, apiGroupAds, audienceAdBuyer, audienceAdSeller, audienceAdMeasurementProvider, skill:Beginner

Privacy Sandbox 包含一系列提案,可在不使用跨网站跟踪的情况下实现广告用例。源起试用为开发者提供了通过实际测试评估新 Web 技术并提供反馈的机会。Privacy Sandbox 相关性和效果衡量源试用提供了一项试用,让网站能够在 Attribution Reporting、Protected Audience API、Topics、Fenced Frames 和 Shared Storage 中运行统一的实验。开发者可以注册参加这项单一源试用,以便跨 Topics API、Protected Audience API 和 Attribution Reporting API 进行测试。本指南将引导您完成访问 API 的配置步骤,告诉您如何验证配置,并提供针对 API 进行测试的更多资源。

查看来源试用版的状态

2023 年 6 月

在稳定版中,不公开汇总功能的增速为 7%

自 2023 年 6 月 6 日星期二起,7% 的 Chrome 稳定版流量将支持 Private Aggregation API。该 API 将在主要的统一源试用组(5%)、Protected Audience 隔离组(1%)和 Shared Storage 隔离组(1%)中提供。由于 Private Aggregation 将添加到现有的隔离实验中,因此 Protected Audience 和 Shared Storage 的流量分配不会发生变化。

自 6 月 6 日(星期二)起的流量分配:

API 流量分配 状态
Attribution Reporting 统一 - 5% 占稳定流量的 6%(截至 2023 年 3 月 13 日)
隔离 - 1% - 仅限 ARA
Fenced Frames 统一 - 5% 7% 的稳定流量(截至 2023 年 3 月 13 日)
隔离 - 1% - 仅使用 Shared Storage + Private Aggregation + Fenced Frames
隔离 - 1% - 仅使用 Protected Audience + 私有汇总 + 围栏框
Protected Audience 统一 - 5% 占稳定流量的 6%(截至 2023 年 3 月 13 日)
隔离 - 1% - 仅使用 Protected Audience + 私有汇总 + 围栏框
不公开汇总 统一 - 5% 截至 2023 年 6 月 6 日,稳定流量的 7%
隔离 - 1% - 仅使用 Protected Audience + 私有汇总 + 围栏框
隔离 - 1% - 仅限共享存储空间 + 不公开汇总 + 围栏帧
共享存储空间 统一 - 5% 占稳定流量的 6%(截至 2023 年 3 月 13 日)
隔离 - 1% - 仅使用 Shared Storage + Private Aggregation + Fenced Frames
主题 统一 - 5% 占稳定流量的 6%(截至 2023 年 3 月 13 日)
隔离 - 1% - 仅限主题

查看与来源试用版相关的之前动态。

2023 年 4 月

在稳定版中,不公开汇总功能的增速为 1%

从 4 月 17 日(星期一)开始,1% 的 Chrome 稳定版统一实验流量将参与 Private Aggregation API 源试用。Private Aggregation 的 sendHistogramReport() 函数可在 Protected Audience APIShared Storage 工作件中使用。

自 4 月 17 日(星期一)起,流量分配将如下所示:

API 流量分配 状态
Attribution Reporting 统一 - 5% 自 2023 年 3 月 13 日起,稳定版流量的 6%
隔离 - 1% - 仅限 ARA
Fenced Frames 统一 - 5% 7% 的稳定版流量(自 2023 年 3 月 13 日起)
隔离 - 1% - 仅限共享存储空间(网址选择)+ 围栏帧
隔离 - 1% - 仅限 Protected Audience API + 围栏帧
Protected Audience API 统一 - 5% 自 2023 年 3 月 13 日起,稳定版流量的 6%
隔离 - 1% - 仅限 Protected Audience API + 围栏帧
不公开汇总 统一 - 1% 自 2023 年 4 月 17 日起,1% 的稳定版流量
共享存储空间(网址选择) 统一 - 5% 自 2023 年 3 月 13 日起,稳定版流量的 6%
隔离 - 1% - 仅限共享存储空间(网址选择)+ 围栏帧
主题 统一 - 5% 自 2023 年 3 月 13 日起,稳定版流量的 6%
隔离 - 1% - 仅限主题

2023 年 3 月

时间表更新

我们最初曾表示将于 2023 年 3 月 13 日(星期一)开始进行隔离实验,但由于设置实验需要额外的时间,因此新实验将于 2023 年 3 月 16 日(星期四)开始。2023 年 3 月 16 日(星期四)还将将 Protected Audience API 的覆盖率从 4% 提高到 5%。

Protected Audience API 恢复 1% 的增速

上个月,我们暂时将 Protected Audience API 源试用流量从 Chrome 稳定版流量的 5% 降低到了 4%,以便进行测试。初步测试已结束,我们计划于 2023 年 3 月 16 日星期四将 Protected Audience API 的覆盖率从 4% 提高到 5%,以便开展统一实验。

增加用户数的对象将与减少用户数的对象相同。不过,由于从逐步缩减开始已超过 30 天,其之前的兴趣群体已过期。

隔离实验

为了改进测试流程并继续观察原始测试 API 的指标,除了现有的统一实验之外,我们还将为每个 API 创建单独的实验。系统将为 Attribution Reporting、Topics、Protected Audience API 和 Fenced Frames 组合以及 Shared Storage 的网址选择操作和 Fenced Frames 组合创建新的实验。在每个隔离的实验中,该组中的用户只能使用分配给该组的 API。

API 隔离的实验
流量分配
Attribution Reporting 1%
Protected Audience API + 围栏框 1%
共享存储空间(网址选择)+ 围栏帧 1%
主题 1%

自 3 月 16 日星期四起,您将开始通过上述 API 获得额外的 1% 的 Chrome 稳定版流量,这与您从现有统一实验中获得的 5% 流量相加。系统会将新用户分配给每个实验。

流量分配

截至 2 月 28 日(星期二),统一来源测试流量分配如下:

API 当前统一实验
流量分配
Attribution Reporting 5%
Fenced Frames 5%
Protected Audience API 4%
共享存储空间(网址选择) 5%
主题 5%

从 3 月 16 日(星期四)开始,在 Protected Audience API 恢复使用并开始新的隔离实验后,流量分配将如下所示:

API 新的流量分配 状态
Attribution Reporting 统一 - 5% 自 2023 年 3 月 16 日起,稳定版流量的 6%
隔离 - 1% - 仅限 ARA
Fenced Frames 统一 - 5% 自 2023 年 3 月 16 日起,7% 的稳定版流量
隔离 - 1% - 仅限共享存储空间(网址选择)+ 围栏帧
隔离 - 1% - 仅限 Protected Audience API + 围栏帧
Protected Audience API 统一 - 5%(4% 当前分配比例 + 1% 逐步恢复) 自 2023 年 3 月 16 日起,稳定版流量的 6%
隔离 - 1% - 仅限 Protected Audience API + 围栏帧
共享存储空间
(网址选择)
统一 - 5% 自 2023 年 3 月 16 日起,稳定版流量的 6%
隔离 - 1% - 仅限共享存储空间(网址选择)+ 围栏帧
主题 统一 - 5% 自 2023 年 3 月 16 日起,稳定版流量的 6%
隔离 - 1% - 仅限主题

这些更改不会影响您现有的来源试用令牌设置,您也不必续订或生成新的来源试用令牌。

2023 年 1 月

作为 Chrome 回归问题调查的一部分,自 2023 年 1 月 26 日起,我们将暂时将 Protected Audience API 源试用流量从 Chrome 稳定版流量的 5% 暂时降至 4%。我们估计调查过程大约需要一个月的时间,当流量恢复正常时,我们会通知您。

这项更改将自动进行,不会影响您现有的来源试用令牌。对于将逐步减少的 1% 流量中的用户,兴趣群组将保留在他们的浏览器中。这些用户将在重新启动时纳入考虑范围,并且其兴趣群体可以重复使用。不过,兴趣群体会在 30 天后过期,而回归问题调查可能需要更长时间。

此外,自 2023 年 1 月 26 日起,Shared Storage 的网址选择 API 源试用将扩大到 5% 的 Chrome 稳定版流量。

API 备注
归因报告 在稳定版中提供,自 2022 年 10 月 26 日起上调至 5%。
主题 在稳定版中提供,自 2022 年 10 月 26 日起上调至 5%。
Protected Audience API 已在稳定版中推出,自 2023 年 1 月 26 日起暂时降至 4%。
Fenced Frames 已在稳定版中推出,自 2022 年 11 月 9 日起将提高至 5%。
Shared Storage 已在稳定版中推出,自 2023 年 1 月 26 日起上调 5%。

2022 年 11 月

自 11 月 9 日起,Shared Storage 的 `select网址` API 将加入源试用,占 Chrome 稳定版流量的 1%。

正如之前在将 Privacy Sandbox 相关性和衡量源试用范围扩大到 5% 一文中所宣布的那样,Attribution Reporting API 和 Topics 现在已扩大到 5%,Protected Audience API 和 Fenced Frames 也将于 11 月 9 日扩大到 5%。

API 备注
归因报告 已在稳定版中推出,自 10 月 26 日起上调至 5%。
主题 已在稳定版中推出,自 10 月 26 日起上调至 5%。
Protected Audience API 已在稳定版中推出,自 11 月 9 日起将提高至 5%。
Fenced Frames 已在稳定版中推出,自 11 月 9 日起将提高至 5%。
Shared Storage 将在稳定版中推出,从 11 月 9 日起开始,采用 1% 的采用率。

2022 年 10 月:增加 5%

Attribution Reporting、Topics、Protected Audience API 和 Fenced Frames 目前均已在 Chrome 稳定版中推出,并将纳入到增加的流量中。

我们将从本周开始增加 Attribution Reporting 和 Topics 的流量,从 11 月 9 日起增加 Protected Audience API 和 Fenced Frames 的流量。

如需了解详情,请参阅将 Privacy Sandbox 相关性和效果衡量来源试用范围扩大到 5% 一文。

API 备注
归因报告 已在稳定版中推出,10 月 26 日后将提高至 5%。
主题 已在稳定版中推出,10 月 26 日后将提高至 5%。
Protected Audience API 已在稳定版中推出,自 11 月 9 日起将提高至 5%。
Fenced Frames 已在稳定版中推出,自 11 月 9 日起将提高至 5%。
Shared Storage 目前仅在 M105 及更高版本的 Canary 版、开发者版和 Beta 版中提供。

2022 年 10 月

我们延长了此期限,以便稳定版渠道中的生态系统有时间继续测试和验证 API 改进,同时提供与我们现有公开时间表一致的反馈。

Privacy Sandbox 时间表总体保持不变。

试用期内可使用的 API:

API 备注
归因报告 有关来源试用版的开发者指南
Protected Audience API 有关来源试用版的开发者指南
主题 有关来源试用版的开发者指南
Fenced Frames 如需了解如何使用源试用,请参阅 Protected Audience API 指南。
共享存储空间 目前仅在 M105 及更高版本的 Canary 版、开发者版和 Beta 版中提供。

2022 年 8 月

  • 从 Chrome 稳定版 104 开始,源起试用范围将逐步扩大到1% 的桌面版用户
  • 当移动用户也能使用该功能时,我们会及时通知您。
  • 预稳定版渠道(Canary 版、Beta 版)仍占 50% 的用户。
  • API 不适用于 iOS 版 Chrome。

2022 年 5 月

从 Chrome 102 Beta 版开始,将逐步面向 50% 的用户推出来源试用

试用期内可使用的 API:

API 备注
归因报告 有关来源试用版的开发者指南
Protected Audience API 有关来源试用版的开发者指南
主题 有关来源测试的开发者指南。由于影响浏览器稳定性的 bug,我们在源代码测试中暂时停用了“主题”。
Fenced Frames 向源试验添加了围栏帧。如需了解实验用法,请参阅 Protected Audience API 指南。

2022 年 4 月

源起试用将从Chrome 102 Beta 版的一小部分用户开始。

试用期内可使用的 API:

API 备注
归因报告 Intent to Experiment (I2E) 帖子。归因报告也可作为单独的来源试用。
Protected Audience API Intent to Experiment (I2E) 帖子。Protected Audience API 仅适用于桌面设备,且提供部分功能
主题 Intent to Experiment (I2E) 个人帖子。

注册并配置源试用

如需在您的网站上启用源试用,您需要注册并嵌入分配的源试用令牌(一种基于时间的字符串,用于为您提供对源试用的特定访问权限)。如需了解详情,请参阅 Chrome 源试用入门

系统会立即授予源试用令牌,您可以随时撤消或重新创建这些令牌。

对于您要使用来源试用版的每个网页,您都需要在该特定网页的 HTML 或响应中添加试用令牌。

在网页的 <head> 部分使用 <meta> 标记:

<meta http-equiv="origin-trial" content="TOKEN_GOES_HERE">

或者,您也可以在网页响应中添加以下 HTTP 标头:

Origin-Trial: TOKEN_GOES_HERE

使用 iframe 进行配置

如果您要在 iframe 中使用源试用功能(例如 Protected Audience API 的 joinAdInterestGroup()),则需要在 iframe 中提供令牌,并且令牌应与 iframe 的来源一致。

使用 JavaScript 配置跨站点

如果您是通过跨网站 JavaScript 使用来源试用功能(例如,您是包含在顶级网页中的第三方 JavaScript 的提供方),则需要满足以下条件:

  • 注册来源试用版时,选择第三方匹配选项。
  • “Web Origin”字段应为脚本的来源。
  • 通过脚本将 <meta> 标记注入顶级网页(即第一方网页,而不是您自己的内容)。例如:
const otMeta = document.createElement('meta');
otMeta.setAttribute('http-equiv', 'origin-trial');
otMeta.setAttribute('content', 'TOKEN_GOES_HERE');
document.querySelector('head').appendChild(otMeta);

调试源试用

您可以在 DevTools > Applications 面板中查看来源试用版的状态。

令牌状态为“成功”且已启用。
令牌成功状态且已启用。
  1. 向下滚动到窗格。
  2. 选择您预计设置令牌的帧。例如,顶级网页的顶部框架或嵌入式网页的特定 iframe
  3. 在右侧窗格中,向下滚动到来源试用部分。
  4. 您应该会看到 PrivacySandboxAdsAPIs 试用期的条目。
  5. 展开此条目可查看来源试用和您的具体令牌的状态。

此源代码测试仅面向部分 Chrome 用户,您的浏览器可能不在实验组中。因此,您可能会看到针对 PrivacySandboxAdsAPIs 的红色 TrialNotAllowed 消息。展开该条目以查看令牌状态时,如果系统显示绿色的 Success 消息,则表示您的来源测试配置正确无误。符合条件的用户会看到消息设置为 Enabled

令牌状态为“成功”,且未启用。
令牌成功状态且未启用。

如果您看到其他消息,请参阅排查 Chrome 源试验问题,查看详细的核对清单,以验证您对源试验的配置。

检测地图项

与所有 Web 功能一样,您应先检查这些功能在浏览器中是否显示为可用,然后再尝试使用它们。为此,您可以检查相关 API 是否位于正确的位置:

if (document.featurePolicy.allowsFeature('attribution-reporting')) {
  // Attribution Reporting enabled
}

if ('runAdAuction' in navigator) {
  // Protected Audience API enabled
}

if ('browsingTopics' in document) {
  // Topics enabled
}

if ('HTMLFencedFrameElement' in window) {
  // Fenced Frames enabled
}

if ('sharedStorage' in window) {
  // Shared Storage enabled
}

if (window?.sharedStorage?.selectURL instanceof Function) {
  // optionally check specifically for the selectURL function in Shared Storage
}

确定用户是否符合条件

我们正在面向部分 Chrome 用户开展源代码试用。此外,他们还必须在设置中启用相关功能,才能参与试用:

浏览器设置

用户必须满足以下条件,才能参与试用:

  • 使用正在运行源试用版的 Chrome 版本和渠道

  • 属于 Chrome 中的有效实验组

用户设置

用户还必须满足以下条件,才能参与试用:

  • 启用 Privacy Sandbox 试用版,具体方法是前往“设置”>“安全和隐私”>“Privacy Sandbox”(也可通过 chrome://settings/adPrivacy 访问)。
  • 启用了第三方 Cookie,具体方法是依次前往“设置”>“安全和隐私”>“Cookie 及其他网站数据”,将其设为“允许所有 Cookie”或“在无痕模式下屏蔽第三方 Cookie”(也可通过 chrome://settings/cookies 访问)。
  • 处于标准浏览会话中,而不是无痕模式

虽然来源试用版仅会向符合条件的用户显示为有效,但您还可以使用开发者标志对自己的生产网站进行测试。

控制您是否参与源代码试用

来源试用机制保持不变:您需要为要对 API 进行实验的上下文获取来源试用令牌。随着测试对象群体的扩大,您应确保积极监控和控制您选择启用试用版的流量水平。

一个不错的方法是:

  1. 默认情况下,在您要进行实验的所有情境中添加来源测试令牌。
  2. 使用功能检测来检查是否有活跃的 API。
  3. 如果这些 API 处于启用状态(因此浏览器符合此实验的条件),请根据您自己的实验条件选择是否使用这些 API。例如,如果您已经拥有 A/B 测试基础架构,可对流量百分比、抽样或某些其他属性进行实验,那么此时您可以决定要积极使用哪些功能。

您可以通过不将令牌包含在响应中,完全禁止任何浏览器实例参与源试用。例如,如果您已达到实验的配额上限,或者需要在试用期间解决问题,则不添加令牌可确保页面中不会显示任何实验性功能或这些功能不会处于启用状态。

按地理区域控制来源测试

您无法为特定地区停用原产地试行。源站试用仅适用于包含令牌的网页,这些令牌是通过 HTTP 标头(服务器端)或 HTML 元标记(客户端)添加的。

如果您可以确定用户的位置,则可以编写代码,以便根据该位置信息添加来源试用令牌。例如,您可以尝试使用 IP 地址来确定用户的位置。IP 地址可能会被欺骗,因此这并不是一个保证有效的解决方案。

不过,特定地理位置的来源可以设置权限政策来控制可使用的功能。例如,us.example.comuk.example.com 是可控的地理位置来源。这并不意味着相应地区已选择退出源试用。

使用权限政策时,网站会在其网页中添加一小段代码,以向浏览器提供相关说明。页面加载时,浏览器会读取权限政策说明,并允许或屏蔽权限政策中所述的功能(或 API)。如果某个网站想要限制特定区域内的 API,开发者可以为从该区域请求的所有网页设置政策。

续订令牌

Origin 试用令牌会在发行日期后的 6 周过期(如果试用期结束时间更早,则以试用期结束时间为准)。

请务必在该期限内续订并部署新的令牌,以便不间断地使用原始试用版功能。

续订令牌只需几分钟时间,您可以在同一页面中为同一试用部署多个令牌。您可以在现有令牌过期之前部署续期令牌,以免用户服务中断。

在本地测试

如需有关本地开发者测试的具体指南,请参阅:

这些 API 默认处于关闭状态,必须使用标志启用才能进行测试。您应确保已启用上述相同的配置设置,然后执行以下操作:

  • 使用支持相应功能的 Chrome 版本和渠道
  • 启用 chrome://settings/adPrivacy 下的所有广告隐私权 API。

请参阅开发者指南,了解特定 API 和功能是否可用,以及其他标志是否可用于更精细的配置。