contextData

最近更新： 2024年10月5日
  • 主题：

创建对象：

  • 管理员
  • 开发人员

上下文数据变量允许您在处理规则可读取的每个页面上定义自定义变量。您可以在上下文数据变量中发送数据，而不是显式地为代码中的 Analytics 变量分配值。然后，处理规则会接收上下文数据变量值并将其传递给相应的 Analytics 变量。请参阅《管理员用户指南》中的处理规则。

上下文数据变量有助于开发团队收集指定元素中的数据而不是编号变量。例如，您可以请求开发团队将页面的作者分配给 s.contextData["author"]，而不是请求他们将其分配给 eVar10。然后，贵组织中的 Analytics 管理员可以创建处理规则，以将上下文数据变量映射到用于报告的 Analytics 变量。开发团队最终只需担心上下文数据变量，而无需考虑Adobe提供的许多页面变量。

使用 Web SDK 的上下文数据变量

如果使用​ XDM对象，则所有未映射到Adobe Analytics变量的字段都会自动包含为上下文数据变量。 您还可以使用XDM对象显式设置上下文数据。 然后，您可以使用处理规则将上下文数据变量分配给所需的Analytics变量。 有关详细信息，请参阅将其他XDM字段映射到Analytics变量。

如果使用​ 数据对象，则所有上下文数据变量都将作为键值对驻留在data.__adobe.analytics.contextData中：

alloy("sendEvent", {
  "data": {
    "__adobe": {
      "analytics": {
        "contextData": {
          "example_variable": "Example value",
          "second_example": "Another value"
        }
      }
    }
  }
});

处理规则界面将在适用的下拉菜单中显示c.example_variable和c.second_example。

使用 Adobe Analytics 扩展程序的上下文数据变量

Adobe Experience Platform 数据收集中没有专门的位置来设置上下文数据变量。按照 AppMeasurement 语法使用自定义代码编辑器。

AppMeasurement 和 Analytics 扩展自定义代码编辑器中的 s.contextData

s.contextData 变量不会直接接收值。它会将此变量的属性设置为字符串。

// Assign the example_variable property a value
s.contextData["example_variable"] = "Example value";
  • 有效的上下文数据变量只包含字母数字字符、下划线和句点。如果您包括其他字符（如连字符），则 Adobe 无法对处理规则中的数据收集提供担保。
  • 请勿将上下文数据变量以 "a." 开头。此前缀由 Adobe 保留和使用。例如，请勿使用 s.contextData["a.InstallEvent"]。
  • 上下文数据变量不区分大小写。变量 s.contextData["example"] 和 s.contextData["EXAMPLE"] 是相同的。
  • 单个键不能包含多个值。 如果要将上下文数据变量用于多值变量，请使用分隔符（通常是逗号）连接所有值，然后使用处理规则将其传递到列表prop或列表变量。

使用处理规则填充 Analytics 变量

WARNING
运行处理规则后，上下文数据变量将被丢弃。如果没有可将值置于变量的处于活动状态的处理规则，则该数据会永久丢失！
  1. 更新您的实施以设置上下文数据变量名称和值。
  2. 登录到Adobe Analytics，然后转到​ 管理员 > 报表 ​套件。
  3. 选择所需的报表包，然后转到​ 编辑设置 > 常规 > 处理规则。
  4. 创建一个将 Analytics 变量设置为上下文数据变量值的处理规则。
  5. 保存更改。

处理规则在保存后会立即生效。它们不适用于历史记录数据。

在链接跟踪调用中发送上下文数据

将上下文数据变量作为 contextData 的属性包含在 s.linkTrackVars 中：

s.contextData["example_variable"] = "Example value";
s.linkTrackVars = "contextData.example_variable";
s.tl(true,"o","Example context data link");

使用上下文数据变量递增事件

创建处理规则时，可以将上下文数据变量分配给事件。

  • 如果上下文数据变量包含任何类型的文本，则事件将递增 1。
  • 如果上下文数据变量包含整数，则事件将按该整数量递增。
// Assigning this context data variable to an event increments it by one
s.contextData["example_text"] = "Text value";

// Assigning this context data variable to an event increments it by four
s.contextData["example_number"] = "4";

Analytics