Edge 扩展的数据元素类型

注意

Adobe Experience Platform Launch正在Experience Platform中被重新命名为一套数据收集技术。 因此,在产品文档中推出了一些术语更改。 有关术语更改的统一参考,请参阅以下文档

数据元素类型库模块的用途是检索一段数据。 用于此检索的方法是可定制的。 不同的数据元素类型允许Adobe Experience Platform用户从本地存储、Cookie或DOM元素中检索数据。

重要

本文档提供了有关Web扩展的数据元素类型的信息。 如果要开发 Edge 扩展,请另外参阅关于 Edge 扩展的数据元素类型的指南。

本文档还假定您熟悉库模块以及它们在标记扩展中的集成方式。 如果您需要查看简介,请在返回本指南之前参阅关于库模块格式的概述。

假设您想要允许用户从名为 productName 的本地存储项中检索一段数据。您的模块可能如下所示:

module.exports = function(settings) {
  return localStorage.getItem('productName');
}

如果要使Adobe Experience Platform用户可配置本地存储项名称,则可以允许用户输入名称,然后将该名称保存到settings对象。 该对象可能如下所示:

{
  itemName: "campaignId"
}

要对用户定义的本地存储项名称执行操作,您的模块需要更改为:

module.exports = function(settings) {
  return localStorage.getItem(settings.itemName);
}

默认值支持

请注意,用户可以选择为任何数据元素配置默认值。如果您的数据元素库模块返回值 undefinednull,则它将被自动替换为用户为数据元素配置的默认值。

上下文事件数据

如果因为触发了规则而导致检索数据元素(例如数据元素在规则的条件和操作中使用),则会将第二个参数传递给您的模块,其中包含有关触发规则的事件的上下文信息。该参数在某些情况下可能会有所帮助并且可以按如下方式访问:

module.exports = function(settings, event) {
  // event contains information regarding the event that fired the rule
};

event 对象必须包含以下属性:

属性 描述
$type 描述扩展名称和事件名称的字符串,使用句点连接。例如,youtube.play
$rule 包含有关当前正在执行的规则的信息的对象。该对象必须包含以下子属性:
  • id:当前正在执行的规则的 ID。
  • name:当前正在执行的规则的名称。

提供触发规则的事件类型的扩展可以选择性地向此 event 对象添加任何其他有用信息。

在此页面上