amp-experiment
描述
用于在 AMP 页面上进行用户体验实验。
必需脚本
<script async custom-element="amp-experiment" src="https://cdn.ampproject.org/v0/amp-experiment-0.1.js"></script>
用法
使用 amp-experiment
组件进行用户体验实验,例如 A/B 测试和多变量测试,并收集相应的数据。
<amp-experiment>
提供用于定义可自定义变体的钩子,并根据配置将流量分配给每个变体。对于每个页面视图,变体分配也会暴露给 amp-pixel
和 amp-analytics
,以便可以收集必要的数据以进行跨变体的统计比较。
支持用户粘性变体分配,以便为同一客户端提供一致的用户体验。此功能依赖于 AMP 的 客户端 ID 功能来提供在页面视图之间一致的随机值。请注意,使用此行为的此功能可能需要更新您的隐私政策或在某些司法管辖区获得最终用户同意。(如果这对您很重要,请参阅下面的 consentNotificationId
。)
可以在同一 AMP 文档上并行运行多个实验,每个实验都有自己的一组变体。在用户粘性模式下,分配在不同的实验之间是正交的,这意味着来自不同实验的 2 个变体(用户组)之间将没有相关性。
配置
实验的配置在 JSON 对象中指定。
<amp-experiment> <script type="application/json"> { "aExperiment": { "sticky": true, "consentNotificationId": "consent-notif", "variants": { "treatment1": 12.5, "treatment2": 12.5, "treatment3": 25.0 } }, "bExperiment": {...} } </script> </amp-experiment>
在顶层,JSON 是一个实验配置映射,键是实验名称。在每个实验中,可用设置在下表中描述
名称 | 是必填字段吗? | 描述 |
---|---|---|
sticky | 否,默认值=true | 实验分配是否对用户具有粘性。 |
consentNotificationId | 否,默认值=undefined | 在可以进行粘性实验之前要解除的 amp-user-notification 的元素 ID。为了不阻止页面渲染,如果在本访问之前未提供同意,则将跳过指定此字段的实验。也就是说,只有获得用户同意的返回访问才能触发此类实验。此设置仅在 sticky=true 时相关。 |
variants | 是 | 一个名称到百分比的映射,其中百分比是一个大于 0 且小于 100 的浮点数,表示将分配给该变体的流量大小。变体的总和不必达到 100%。在这种情况下,将有一部分流量分配给名为 none 的变体,这是一个保留关键字,表示未分配任何变体。 |
高级设置 | ||
cidScope | 否,默认值=amp-experiment | 用户粘性实验的 CID 范围。仅当您想重用现有 CID 时才有用。此设置仅在 sticky=true 时相关。 |
group | 否,默认值={experimentName} | 具有相同组名称的实验将共享相同的 CID 空间。仅当多个实验想要具有相关的用户分组时才有用。此设置仅在 sticky=true 时相关。 |
实验名称和变体名称中使用的字符限制为 [a-z,A-Z,0-9,-,_]。
none
是一个保留关键字,不能使用。
分析
分配的变体可以作为 URL 替换变量:VARIANT(experiment)
<amp-pixel src="https://example.com?xname=aExperiment&xvar=VARIANT(aExperiment)" ></amp-pixel>
对于没有分配任何变体的实验,此变量解析为字符串文字 none
。
变量 VARIANTS
返回以以下格式序列化的所有变体
{experiment1}.{variant}!{experiment2}.{variant}...
例如,URL https://example.com?variants=VARIANTS
展开为
https://example.com?variants=aExperiment.treatmentA!bExperiment.treatmentB
覆盖变体分配
可以通过 URL 片段将实验强制设置为一个变体。这在开发中很有用。
https://example.com/amparticle#amp-x-experiment=treatment
请注意,使用与 body 属性中相同的前缀 amp-x-
。
样式
设置变体样式
对于每个实验,分配的变体都作为文档的 body 元素的属性公开。
<body amp-x-aExperiment="treatment1" amp-x-bExperiment="treatment3"></body>
请注意,实验名称带有前缀 amp-x-
,以避免命名冲突。将忽略未分配任何变体的实验。
使用 CSS 属性选择器来设置文档的样式。例如,下面的代码隐藏实验 aExperiment
的 treatment1
组的测试横幅
body[amp-x-aExperiment='treatment1'] .test-banner { display: none; }
验证
一个 AMP 文档最多只能有一个 amp-experiment
元素。请参阅 AMP 验证器规范中的 amp-experiment 规则。
您已经阅读过本文档十几次,但它并没有真正涵盖您的所有问题?也许其他人也有同样的感觉:请在 Stack Overflow 上联系他们。
转到 Stack Overflow 发现错误或缺少功能?AMP 项目强烈鼓励您的参与和贡献!我们希望您成为我们开源社区的持续参与者,但也欢迎您为自己特别关注的问题做出一次性贡献。
转到 GitHub