将你的分析工具与 AMP 集成
概述
如果你运营着一种软件即服务工具,以便发布商更好地了解其流量和访问者,你可能希望将你的服务集成到 amp-analytics
中。这将使你的客户能够查看其 AMP HTML 页面的流量模式。
开始之前
在你将你的分析服务添加到 AMP HTML 运行时之前,你可能需要
- 识别 AMP HTML 文档中你的分析服务所需的 变量 和 请求 类型。
- 识别导致从页面发送分析请求的触发器,这些触发器与你的服务相关。
- 考虑是否以及如何 跨第一方和第三方 AMP 上下文跟踪用户。
- 确定您的分析仪表板如何处理 AMP 流量。
- 识别
amp-analytics
中缺少的功能,并提交请求以获取所需的功能。 - AMP Analytics 将其变量发送到预先配置的端点。如果您还没有现有端点,请查看此示例,以了解如何构建端点的概述。
- 对于除
iframe
之外的所有传输类型,变量作为 HTTPS 请求中的查询字符串参数发送。 - 对于
iframe
传输类型,将创建一个 iframe,并通过window.postMessage
向其发送变量。在这种情况下,消息不必是 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 变量 参考文档