将您的分析工具与 AMP 集成
概述
如果您运营一个软件即服务工具,供发布商更好地了解其流量和访问者,您可能需要将您的服务集成到 amp-analytics
中。这将使您的客户能够查看其 AMP HTML 页面的流量模式。
开始之前
在将您的分析服务添加到 AMP HTML 运行时之前,您可能需要
- 确定在 AMP HTML 文档中,您的分析服务需要哪些类型的变量和请求。
- 确定哪些触发器会导致从页面发送分析请求,这些请求与您的服务相关。
- 考虑您是否以及如何跨第一方和第三方 AMP 环境跟踪用户。
- 确定您的分析仪表板如何处理 AMP 流量。
- 确定
amp-analytics
中是否有任何缺少的功能,并提交对所需功能的请求。 - AMP Analytics 将其变量发送到预配置的端点。如果您还没有现有的端点,请查看此示例,了解如何构建端点。
- 对于除
iframe
之外的所有传输类型,变量都以 HTTPS 请求中的查询字符串参数的形式发送。 - 对于
iframe
传输类型,会创建一个 iframe,并通过window.postMessage
将变量发送到该 iframe。在这种情况下,消息不必是 URL。此选项仅适用于 MRC 认可的供应商。
- 对于除
- 考虑与
amp-analytics
的集成如何影响您可能拥有的任何政策(特别是您的隐私政策)或协议。
将您的配置添加到 AMP HTML 运行时
- 创建一个意图实现问题,说明您将把您的分析服务的配置添加到 AMP HTML 的运行时。请务必在您的描述中添加 cc @ampproject/wg-components。
- 开发一个实现以下内容的补丁
- 在供应商文件夹中创建一个新的配置 json 文件
${vendorName}.json
,其中包括超出默认设置的任何选项,例如- 用于其他默认变量的
"vars": {}
。 - 用于您的服务将使用的请求的
"requests": {}
。 - 如果需要,可以使用
"optout":
。我们目前没有一个很好的退出系统,所以请联系我们,帮助我们设计一个对您有效的方法。 - 如果需要,可以使用
"warningMessage":
。在控制台中显示来自供应商的警告信息(例如,弃用或迁移)。
- 用于其他默认变量的
- 如果您使用的是 iframe 传输,还请在 iframe-transport-vendors.js 中的 ANALYTICS_IFRAME_TRANSPORT_CONFIG 中添加一个新行,其中包含
"*vendor-name*": "*url*"
。 - 在examples/analytics-vendors.amp.html中的示例参考。
- 在 extensions/amp-analytics/0.1/test/vendor-requests.json 文件中进行测试。
- 在 extensions/amp-analytics/0.1/analytics-vendors-list.md 文件中,将您的分析服务添加到支持的供应商列表中。包括类型、描述和指向您的使用文档的链接。
- 在供应商文件夹中创建一个新的配置 json 文件
- 测试您放入examples/analytics-vendors.amp.html的新示例,以确保示例中的点击按预期工作。例如,所需的数据正在被收集并在您的分析仪表板中显示。
- 提交此补丁的拉取请求,引用意图实现问题。
- 更新您服务的使用文档,并通知您的客户。
- 强烈建议在 AMP 存储库外部维护一个集成测试。
标签管理器
标签管理服务有两种与 AMP Analytics 集成的方式
- 端点方法:充当
amp-analytics
的附加端点,并在后端进行营销管理。 - 配置方法:通过每个发布商特有的动态生成的 JSON 配置文件进行标签管理。
端点方法与上一节中详述的标准方法相同。配置方法包括为每个发布商创建特定的 amp-analytics 配置,其中包括所有兼容的分析软件包。发布商将使用类似于以下语法的配置:
<amp-analytics config="https://my-awesome-tag-manager.example.com/user-id.json" ></amp-analytics>
要采用这种方法,请查看有关发布商与 AMP Analytics 集成的文档。
更多资源
- 深入了解:为什么不直接使用 iframe?
- 深入了解:使用 AMP 管理未经验证的用户状态
- amp-analytics 示例
- amp-analytics 参考文档
- amp-analytics 变量参考文档