上载和实施端到端测试

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

要在Adobe Experience Platform中测试标记扩展,请使用标记API和/或命令行工具来上传扩展包。 接下来,使用Platform UI或数据收集UI将扩展包安装到资产,并在标记库和内部版本中练习其功能。

本文档介绍了如何对扩展实施端到端测试。

NOTE
本指南假定您使用的是MacOS以及已安装并可用的Node.js和npm。

验证扩展 validate

如果您的团队对扩展的性能以及他们在 沙盒 工具中,您应该准备好将扩展包上传到标记。

上载之前,请验证是否存在任何必填字段或设置。例如,查看您的 扩展清单,您的 扩展配置,您的 查看次数,以及您的 库模块 (至少)是良好做法。

您的徽标文件就是一个具体示例:向 extension.json 文件中添加 "iconPath": "example.svg", 行,并将该徽标图像文件添加到项目中。这是将为扩展显示的图标的相对路径。 它不应以斜杠开头,必须引用一个扩展名为 .svg 的 SVG 文件。SVG在呈现为正方形时应正常显示,并且可通过用户界面进行缩放。 请参阅 如何缩放SVG文章 了解更多详细信息。

NOTE
对于公共扩展,请在 extension.json 中添加一个项目,并包含指向 Exchange 列表的链接。您的扩展清单应包含如下条目:"exchangeUrl":"https://www.adobeexchange.com/experiencecloud.details.12345.html",以指向 Exchange 列表的 URL。

创建 Adobe I/O 集成 integration

要使用API或命令行工具,您需要具有Adobe I/O的技术帐户。您必须在I/O控制台中创建技术帐户,然后使用Uploader工具上载扩展包。

有关创建用于Adobe Experience Platform标记的技术帐户的信息,请参阅 Reactor API快速入门 指南。

IMPORTANT
要在 Adobe I/O 中创建集成,您必须是 Experience Cloud 组织管理员或 Experience Cloud 组织开发人员。

如果无法创建集成,则您可能没有正确的权限。 这需要组织管理员为您完成这些步骤或将您指定为开发人员。

上载扩展包 upload

现在您有了凭据,可以端到端地测试扩展包了。

首次上载扩展包时,它会进入 development 状态。这意味着它仅对您自己的组织可见,并且仅对标记为要进行扩展开发的资产可见。

使用命令行在包含.zip包的目录中运行以下命令。

npx @adobe/reactor-uploader

npx 允许您下载和运行 npm 包,而无需将其实际安装到计算机上。这是运行 Uploader 的最简单方法。

Uploader要求您输入几条信息。 技术帐户ID、API密钥和其他一些信息可以从Adobe I/O控制台中检索。 导航到 I/O 控制台中的集成页面。从下拉列表中选择正确的组织,找到正确的集成,然后选择 视图.

  • 私钥的路径是什么?/path/to/private.key。这是您在上面步骤 2 中保存私钥的位置。
  • 您的组织 ID 是什么?从之前保持打开状态的I/O控制台概述页面中复制并粘贴此内容。
  • 您的技术帐户 ID 是什么?请从I/O控制台复制并粘贴此项。
  • 您的 API 密钥是什么?请从I/O控制台复制并粘贴此项。
  • 客户端密钥是什么? 请从I/O控制台复制并粘贴此项。
  • 要上载的 extension_package 的路径是什么?/path/to/extension_package.zip。如果从包含 .zip 包的目录中调用 Uploader,则只需从列表中选择该包,而不需要键入路径。

随后将上载扩展包,并且 Uploader 将为您提供 extension_package 的 ID。

NOTE
在上载或打补丁时,扩展包将处于待处理状态,而系统将异步提取该包并进行部署。在此过程中,您可以轮询 extension_package 使用API和UI中反映其状态的ID。 您将在目录中看到一个标记为“Pending(待处理)”的扩展卡片。
NOTE
如果您计划经常运行Uploader,那么每次输入所有这些信息可能会造成负担。 您也可以从命令行将这些参数作为参数传入。 有关更多信息,请参阅 NPM 文档的命令行参数部分。

创建开发资产 property

登录UI并选择 标记 在左侧导航中, 属性 屏幕中显示。 资产是要部署的标记的容器,可用于一个或多个网站。

首次登录时,屏幕上不会显示任何资产。 选择 New Property,以创建一个资产。输入名称和 URL。使用测试网站或要测试扩展的页面的URL。 此域字段可以由某些扩展使用,也可以由使用核心扩展的条件使用。

NOTE
localhost 无法用作URL值。 如果您使用的是,请改为使用任何模拟值进行测试 localhost URL。 例如,example.com。

要将此资产用于扩展开发测试,您必须展开 高级OPTIONS 并确保选中 为扩展开发配置.

选择底部的 Save,以保存您的新资产。

出现“Properties(属性)”屏幕。 选择刚刚创建的资产的名称。此时将显示“属性概述”屏幕。 它提供指向系统每个区域的链接,左侧列中包含全局导航链接。

安装扩展 install-extension

要在此资产中安装扩展,请选择 扩展 左侧列的主导航链接中的链接。 此 核心 扩展显示在 已安装 屏幕。 核心扩展包含数据收集中的所有标记管理功能。

要添加扩展,请选择 目录 选项卡。

目录将显示每个可用扩展的卡图标。如果您的扩展未显示在目录中,请确保您已完成Adobe管理控制台的“设置”和“创建扩展包”部分中的上述步骤。 如果Platform尚未完成初始处理,则扩展包也可能显示为“Pending”。

如果您已执行了上述步骤,但仍未在目录中看到“Pending”或“Failed”扩展包,则应直接使用API检查扩展包的状态。 有关如何进行适当的API调用的信息,请阅读 获取扩展包 在API文档中。

扩展包完成处理后,选择 安装 位于卡片底部。

配置屏幕将打开(如果扩展有此屏幕)。 添加配置扩展所需的任何信息,然后选择底部的 Save。此处显示的配置屏幕示例使用需要像素ID的Facebook扩展。

现在,您应该看到 Installed 扩展页面中包含 Core 扩展和您的扩展。

创建资源以测试扩展 resources

扩展可为Adobe Experience Platform用户提供新功能。 这些规则通常显示在数据元素或规则生成器中。

数据元素

标记数据元素的目的是帮助用户保留值。 每个数据元素都是到源数据的映射或指示符。单个数据元素是一个变量,可以映射到查询字符串、URL、Cookie 值、JavaScript 变量等。选择 数据元素 左侧导航栏中,以及 创建新数据元素.

扩展可以根据需要定义数据元素类型,以便扩展运行,或者只是为用户提供方便。当扩展提供数据元素类型时,这些类型会显示在上的用户的下拉列表中。 创建数据元素 屏幕:

当用户从以下项选择您的扩展时: 扩展 下拉列表 数据元素类型 下拉列表中填充有扩展提供的任何数据元素类型。 然后,用户可以将每个数据元素映射到其源值。接下来,在数据元素更改事件或自定义代码事件中构建规则时,可以使用数据元素来触发要执行的规则。数据元素还可以在数据元素条件或规则中的其他条件、例外或操作中使用。

创建数据元素(设置映射)后,用户只需引用数据元素即可引用源数据。如果值的来源发生变化(网站重新设计等),用户只需在UI中更新一次映射,所有数据元素将自动接收新的源值。

规则

选择 规则 链接,然后 创建新规则.

首先,为规则输入一个描述性名称。 此 创建规则 屏幕的设置类似于 if-then 语句。

如果事件发生,条件通过评估,并且没有例外,则会触发操作。扩展中也存在相同的流程,您可以在其中创建或利用事件、条件、例外、数据元素或操作。

使用Facebook扩展示例,为页面在测试网站上加载的每次情况添加一个事件。

Window Loaded 事件类型 确保每当页面在测试网站上加载时,都会触发此规则。 选择​ 保留更改。对于此示例,请忽略 条件 ,因为测试网站上的任何页面都应触发规则。

操作 选择 添加. 此 操作配置 屏幕显示。接下来,您必须选择要应用规则的扩展以及触发规则时要执行的操作。 选择 facebook Pixel扩展 下拉列表,以及 发送页面查看操作类型 下拉列表。 选择 保留更改,然后 保存 ,具体如下 编辑规则 屏幕。

测试扩展时,请选择任何相关的事件、条件等。 扩展提供的任何事件、条件等。

发布更改 publish

在主导航中,选择 Publishing,然后选择 Add New Library 链接:

库是扩展、数据元素和规则如何彼此交互以及如何与网站交互的一组说明。库会被编译为内部版本。一个库可以包含用户希望一次进行或测试的任意多个更改。

创建库 屏幕,在中添加名称 名称 文本字段。 标记提供了一个名为的默认开发环境 开发. 选择 开发环境 下拉列表。 为了简化,请添加所有可用资源。 选择 添加所有更改的资源,然后选择 保存.

NOTE
在将资源添加到库时,将会拍摄该资源截至此确切时间的快照并将其添加到库中。当您稍后对资源进行更改(例如,因为需要进行修复)时,还需要更新库以包含对资源的最新更改。Add All Changed Resources 按钮也可以用于此目的。

现在,所有更改都已包含在新创建的库中(已命名 开发 在提供的示例中),选择 保存并生成到开发环境.

构建过程完成后,显示为绿色 success 指示器显示在库名称旁边。

标记库现已发布并可供使用。 测试页面必须使用新创建的库,以便在浏览器中测试最终用户的页面行为。

在测试网站上安装标记 install-data-collection-tags

安装说明可从“环境”选项卡中获得。 此页面显示所有可用的环境,并允许您创建更多环境。 将库发布到开发环境后,选中 安装 上的列 开发 row。

Web安装说明 此时将显示开发环境的对话框。 选择复制图标以复制整个 <script> 标记之前。

通过放置此单项完成安装 <script> 标记内 <head> 文档或站点模板的部分。 接下来,访问测试网站以检查已发布的标记库的行为。

测试 test

以下是在测试页面或站点上验证扩展的有用控制台命令列表。

  • _satellite.setDebug(true); 将启用调试模式并将有用的日志记录语句输出到控制台。
  • _satellite._container 对象包含有关已部署库的有用信息,包括有关所包含内部版本、数据元素、规则和扩展的详细信息。

此测试的目的是检查已部署库的功能,并确保扩展包在编译到库中后按预期运行。

当发现需要对扩展包进行更改时,迭代过程与开发过程类似。

  1. 更改项目中的代码。

  2. 使用沙盒工具验证更改.

  3. 使用 Packager 工具创建新的 .zip 包

  4. 使用Uploader工具上载新的.zip包。 该过程遵循与之前有关初始上传的相同说明。 但是,您会注意到,由于在开发模式下已存在具有该名称的扩展包,因此此新包将覆盖旧版本,而不是创建新包。

    note note
    NOTE
    可以在命令行上传递参数,以避免重复输入凭据,从而节省时间。 欲知更多信息,请阅读 reactor-uploader文档.

    1. 更新现有包时,可以跳过安装步骤。

  5. 修改资源 — 如果更改了任何扩展组件的配置,则需要在UI中更新这些资源。

  6. 将最新更改添加到库,然后再次构建.

  7. 完成另一轮测试。

recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743