扩展开发入门
注意
Adobe Experience Platform Launch已更名为Adobe Experience Platform中的一套数据收集技术。 因此,产品文档中的术语有一些改动。有关术语更改的综合参考,请参阅以下文档。
为了帮助您启动、运行和构建扩展,我们将使用由 Adobe 工程师提供的开源基架工具为扩展包创建必要的文件和文件结构,因此您要完成的是最有价值的部分:实际编写代码。
先决条件
扩展设置
创建扩展文件的存放目录。
mkdir example && cd example
本指南利用扩展基架工具来构建初始扩展结构,以便开发人员可以快速开始编码。如果需要,可以在不使用基架工具的情况下手动完成此过程。
运行基架工具。
npx @adobe/reactor-scaffold
基架工具将提示输入一些初始配置选项,如下所示:
- 显示名称 - 扩展的可见名称
- 版本 - 扩展的版本
- 描述 - 扩展的简短用途描述
- 作者 - 扩展的作者姓名
然后,基架工具将提供用于构建扩展结构的选项:
- 扩展配置视图:视图 HTML 文件,扩展可通过该文件从用户那里收集全局设置。
- 事件类型:定义要观察的活动。例如,了解用户何时快速滚动,或者用户何时与页面元素交互。然后可以在规则中利用事件来执行操作。
- 条件类型:条件类型评估某些内容是 true 还是 false。例如,如果用户的浏览器是 Chrome,或者他们正在使用 iPad,亦或用户位于特定域中,则可以返回此值。
- 操作类型:事件发生时要执行的操作。例如,发送分析信标、显示选件、保存 Cookie 或打开支持聊天。
- 数据元素类型:数据元素类型检索一段数据。此数据可以位于本地存储、Cookie、DOM 元素或自定义位置中。
- 共享模块:共享模块是扩展可用来与其他扩展进行通信的一种机制。
- 视图:每个事件、条件、操作或数据元素类型可以提供允许用户提供设置的视图。
注意
- 基架工具的后续运行将跳过初始配置。
- 可以添加每个事件、条件、操作的多个视图。
- 只能存在一个配置视图。
后续步骤