Web 扩展的操作类型

上次更新: 2023-05-25
  • 主题:
  • Tags
    查看有关此主题的更多信息
  • 创建对象:
  • Developer
    User
    Admin
    Leader
注意

Adobe Experience Platform Launch已更名为Adobe Experience Platform中的一套数据收集技术。 因此,产品文档中的术语有一些改动。有关术语更改的综合参考,请参阅以下文档

在数据收集标记的上下文中,操作是在发生规则事件且所有条件都通过评估后执行的操作。

例如,扩展可以提供“显示支持聊天”操作类型,该操作类型可以显示支持聊天对话框,以帮助在注销时可能遇到困难的用户。

本文档介绍如何在Adobe Experience Platform中定义Web扩展的操作类型。

重要

本文档介绍 Web 扩展的操作类型。如果您正在开发 Edge 扩展,请另外参阅关于 Edge 扩展的操作类型的指南。

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

操作类型通常包含以下内容:

  1. A 视图 显示在Experience PlatformUI和数据收集UI中,允许用户修改操作的设置。
  2. 在标记运行时库中发出的库模块,用于解释设置并执行操作。
module.exports = function(settings) {
  alert('Thanks for visiting our site!');
};

例如,要使Adobe Experience Platform用户可以配置消息,您可以允许用户输入消息并将其保存到设置对象。 该对象如下所示:

{
  "message": "Thank you for being one of our VIP members!"
}

要对用户定义的消息执行操作,您的模块需要更改为:

module.exports = function(settings) {
  alert(settings.message);
}

上下文事件数据

然后,必须将第二个参数传递到包含有关触发规则的事件的上下文信息的模块。 该参数在某些情况下可能会有所帮助并且可以按如下方式访问:

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

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

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

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

在此页面上