Singular Website SDK 是一项企业功能。如果您有兴趣使用该功能，请联系您的客户成功经理。
| 奇异网站 SDK（GTM 集成） |
|
|---|---|
| 浏览器兼容性 |
|
简介
通过 Singular 网站 SDK，您可以将网站活动归因于营销接触点，并跟踪网站内的用户事件。它也是 Singular 跨设备归因解决方案的关键组件，使分析用户旅程、计算跨平台 LTV 和 ROAS 成为可能。为方便起见，Singular 网站 SDK 已与Google Tag Manager 集成。
前提条件
集成 Singular 网站 SDK 之前，请确保
- 已在网站上配置 Google Tag Manager。
- 您已根据需要为要发送到 Singular 的事件（转换事件和任何自定义事件）设置了 Google Tag Manager触发器。请参阅 Google 文档中的 " 关于触发器"。
- 根据需要为要发送到 Singular 的事件设置 Google Tag Manager变量。例如，如果您想发送交易事件并包含交易收入，您需要为交易总额和货币设置变量。请参阅 Google 文档中的 " 关于变量"。
集成 Singular SDK
初始化 SDK
要在网站中使用 Singular Web SDK，必须添加 Singular 初始化标签。我们建议将此事件设置为网站加载时（如页面浏览时）立即触发。
添加 Singular 初始化标签
- 在 Google 标签管理器账户中，单击标签 > 新建。
- 在 "标签配置"窗口中，单击 "标签配置"，然后在 "标签类型"菜单中选择 "奇异网络跟踪"。
- 在跟踪类型下，选择 "初始化"。
- 填写其他所需参数：
- SDK 密钥和 SDK 保密信息：登录 Singular 账户，进入 "开发人员工具 > SDK 集成 > SDK 密钥"，即可获取这些信息。
- 产品编号：您网站的名称。我们建议您使用主网域的反向 DNS 符号，例如 "com.example"。 这将用于在整个 Singular 平台上识别您的网站。该值还必须与 Singular 平台 "应用程序 "页面上的应用程序 bundleID 相匹配。
- 可选：
- 日志级别： SDK 调试日志到控制台的配置。默认为无。
- 会话超时：在 SDK 创建新会话之前，用户必须在多长时间内处于非活动状态。Singular 发送用户会话以计算用户保留时间，并启用重新参与属性。默认值为 30 分钟。
- 跨子域跟踪
- 单击 "触发"并添加触发器 "页面查看"。
- 单击保存。
注意： 对于 SPA（单页面应用程序），每次路由到不同页面时都应触发PageVisit跟踪类型。不要在加载的第一个页面上调用PageVisit，因为初始化已经报告了页面访问。
可选：设置用户 ID
只要用户在未登录的情况下在网站上执行操作，事件就会通过一个由 Singular 生成的用户 ID 发送给 Singular。但在用户注册或登录后，可以使用网站上使用的用户 ID（如电子邮件地址）向 Singular 发送事件。
Singular 会在用户级数据导出（参见导出归因日志）以及内部 BI 回传（参见配置内部 BI 回传）中使用用户 ID。
向 Singular 发送用户 ID 有两种方法：
- 推荐： 如果知道网站打开时的用户 ID，请在初始化 SDK 时在初始化跟踪类型中设置用户 ID。这样，Singular 就能在第一次访问页面时获得用户 ID。
- 或者，您也可以在运行过程中的任何时候调用登录方法。我们建议在用户 ID 可用时立即调用该方法。
要与 Singular 共享用户 ID，请添加 "登录 "跟踪类型的 Singular 标签：
- 在 Google 标签管理器账户中，单击标签 > 新建。
- 在 "标签配置"窗口中，单击 "标签配置"，然后在 "标签类型"菜单中选择 "Singular Web 跟踪"。
- 在跟踪类型下，选择 "登录"。
- 在 "自定义用户 ID "下，输入包含用户 ID 的 Google 标签管理器变量。
- 单击 "触发"并添加触发事件：用户登录或注册。
- 单击保存。
要取消设置用户 ID，请添加 "注销 "跟踪类型的标签：
- 在 Google 标签管理器账户中，单击标签 > 新建。
- 在 "标签配置"窗口中，单击 "标签配置"，然后在 "标签类型"菜单中选择 "奇异网络跟踪"。
- 在跟踪类型下，选择 "注销"。
- 单击 "触发"并添加触发事件：用户注销。
- 单击保存。
注意：
- 用户 ID 会一直存在，直到使用注销跟踪类型取消设置或用户删除本地存储。
- 关闭/刷新网站不会取消设置用户 ID。
- 在隐身等私密模式下浏览将阻止 Singular 持久化用户 ID，因为关闭浏览器时本地存储会被自动删除。
可选：跟踪事件和收入
跟踪事件（非收入）
Singular可以收集网站内用户事件的相关数据，以帮助分析营销活动的效果并衡量关键绩效指标。例如，您的组织可能希望收集有关用户登录、注册或教程完成情况的数据。
您可以使用事件方法向 Singular 发送事件。
注意事项：
- 我们强烈建议以英文传递事件名称和属性，以保证与第三方合作伙伴和分析解决方案（如果您计划使用它们）的兼容性。
- 事件名称限制为 32 个 ASCII 字符。转换为 UTF-8 后，非 ASCII 字符的字符串必须小于 32 字节。
- 属性和值限制为 500 个 ASCII 字符。
要跟踪自定义事件，请
- 在 Google 标签管理器账户中，单击标签 > 新建。
- 在 "标签配置"窗口中，单击 "标签配置"，然后在 "标签类型"菜单中选择 "奇异网络跟踪"。
- 在跟踪类型下，选择 "自定义事件"。
- 在 "事件名称"下，输入事件名称或之前定义的 Google 标签管理器变量。
- 单击 "触发"并添加触发事件。
- 单击保存。
跟踪收入
Singular可以收集通过网站获得的收入数据，帮助分析营销活动的绩效和投资回报率。Singular 会在报告、日志导出和回帖中向您提供这些数据。
使用 "收入"方法报告事件，"收入"允许你传递自定义事件名称，这样你就可以在Singular报告中按不同类型的收入事件查看收入。
注意 任何以不同货币报告的收入都将自动转换为贵组织首选的货币，具体货币在 Singular 账户中设置。
跟踪收入事件：
- 在 Google 标签管理器账户中，单击标签 > 新建。
- 在 "标签配置"窗口中，单击 "标签配置"，然后在 "标签类型"菜单中选择 "Singular Web 跟踪"。
- 在跟踪类型下，选择 "收入事件"。
- 在 "事件名称"下，输入事件名称或之前定义的 Google 标签管理器变量。
- 在 "货币"下，输入代表三字母 ISO 4217货币代码的变量，如 "美元"、"欧元 "或 "印度卢比"。
- 在 "收入"下，输入一个包含交易金额的变量（可输入十进制值，如 1.99）。
- 单击触发并添加触发事件。
- 单击保存。
可选：跨子域跟踪
默认情况下，Singular 网站 SDK 会生成一个 Singular 设备 ID，并使用浏览器存储将其保存。由于该存储无法在子域之间共享，SDK 最终会为每个子域生成一个新的 ID。
如果要跨子域持久化 Singular 设备 ID，可以使用以下选项之一：
方法 A：使用 Cookie 自动持久化
你可以让Singular SDK使用自定义的第一方cookie来持久化Singular设备ID。选择以下选项并设置要跟踪的主域。
方法 B（高级）：为GTM变量读取Singular设备ID
如果不想让Singular SDK自动持久化设备ID，可以跨域手动持久化ID--例如，使用顶级域cookie或服务器端cookie。该值应是由 Singular 以有效的 UUIDv4 格式生成的 ID。
注：你可以在调用 Init 跟踪类型标记后，定义一个自定义 JavaScript 变量并调用 singularSdk.getSingularDeviceId() 来读取 Singular 设备 ID。
自定义用户 ID 设备映射
重要：这是一项高级功能。实施前请咨询 Singular 解决方案工程师。
Singular 可以通过服务器到服务器集成接收额外的网络跟踪数据。要使用此功能，我们需要将自定义用户 ID 映射到 Singular 的网络跟踪标识符。
注意：在初始化 SDK 或获得自定义用户 ID 后，请尽快调用此跟踪类型。
将自定义用户 ID 映射到 Singular 的网络跟踪标识符：
- 在 Google 标签管理器账户中，单击 标签 > 新建。
- 在 " 标签配置" 窗口 中 ，单击 "标签配置"，在 " 标签类型" 菜单中选择 "Singular Web Tracking"。
- 在 跟踪类型 下 ，选择 "设置设备自定义用户 ID"。
- 在 "自定义用户ID "下 ，输入包含用户 ID 的 Google 标签管理器变量。
- 单击 "触发" 并添加触发事件。
- 单击保存。