Adobe Experience Platform Launch已更名为Adobe Experience Platform中的一套数据收集技术。 因此,产品文档中的术语有一些改动。有关术语更改的综合参考,请参阅以下文档。
Adobe Experience Platform中标记的主要目标之一是创建一个开放的生态系统,在该生态系统中,Adobe以外的工程师可以在其网站和移动应用程序上展示其他功能。 这可以通过标记扩展来实现。 将扩展安装在标记资产上后,该扩展的功能即可供该资产的所有用户使用。
本文档概述了扩展的主要组件,并提供了指向更多文档的链接,以帮助您完成扩展开发过程。
扩展由文件目录组成。具体而言,扩展包含清单文件、库模块和视图。
清单文件(extension.json
)必须存在于目录的根中。 此文件描述扩展的组成以及某些文件在目录中的位置。 清单的功能类似于 package.json
文件中的文件 npm 项目。
库模块是描述不同的文件 组件 扩展提供的逻辑(换句话说,就是要在标记运行时库中发出的逻辑)。 每个库模块文件的内容必须遵循 CommonJS模块标准.
例如,如果要构建名为“发送信标”的操作类型,则必须拥有一个包含发送信标逻辑的文件。 如果使用JavaScript,则可以调用文件 sendBeacon.js
. 此文件的内容将在标记运行时库中发出。
您可以将库模块文件放在扩展目录内的任何所需位置,但前提是说明它们在 extension.json
.
视图是能够加载到中的HTML文件 iframe
元素 标记应用程序中,尤其是通过Platform UI和数据收集UI执行此类操作。 视图必须包含由扩展提供的脚本,并符合小型API要求,才能与应用程序进行通信。
对于任何扩展,最重要的视图文件都是其配置。 请参阅以下部分 扩展配置 以了解更多信息。
对于在视图中使用的库,目前没有任何限制。换言之,您可以使用jQuery、Underscore、React、Angular、Bootstrap或其他。 但是,仍建议让扩展具有与UI相似的外观。
建议将所有与视图相关的文件(HTML、CSS、JavaScript)放置在与库模块文件分离的单个子目录中。在 extension.json
,您可以描述此视图子目录的位置。 然后,Platform将从其Web服务器为此子目录(仅此子目录)提供服务。
每个扩展定义了一组功能。 这些功能通过在中包含以下内容来实现 库 部署到您的网站或应用程序中的受众。 库是单个组件的集合,包括条件、操作、数据元素等。 每个库组件都是一段可重用代码(由扩展提供),它会在标记运行时内发出。
根据您正在开发的是Web扩展还是Edge扩展,可用组件类型及其用例会有所不同。 有关每种扩展类型可用的组件的概述,请参阅下面的子部分。
在 Web 扩展中,规则是通过事件触发的,如果满足给定的条件集,规则即可执行特定的操作。有关更多信息,请参阅有关 Web 扩展中的模块流的概述。
除了 核心模块 由Adobe提供,您可以在Web扩展中定义以下库组件:
有关在Web扩展中实施库组件所需格式的详细信息,请参阅 模块格式概述.
在 Edge 扩展中,规则是通过条件检查触发的,如果这些检查通过,规则将执行特定的操作。请参见 Edge扩展流程 以了解更多信息。
您可以在Edge扩展中定义以下库组件:
有关在 Edge 扩展中实施库模块所需格式的详细信息,请参阅模块格式概述。
扩展配置是指收集来自用户的全局设置的方式。配置由一个视图组件组成,该组件将标记运行时库中的设置作为纯对象导出和发出。
例如,假定某个扩展允许用户使用“发送信标”操作发送信标,并且该信标必须始终包含帐户ID。 每次配置“Send Beacon”操作时,扩展都不应询问用户帐户ID,而是应从扩展配置视图中询问一次帐户ID。 每次发送信标时,“Send Beacon”操作都可从扩展配置中提取帐户ID并将其添加到信标。
当用户在UI中将扩展安装到属性时,将向用户显示扩展配置视图,用户必须完成该视图才能完成安装。
要了解更多信息,请参阅上的指南 扩展配置.
构建完扩展后,您可以提交该扩展,以将其列在Platform的扩展目录中。 请参阅 扩展提交过程概述 以了解更多信息。