文档Experience PlatformWeb SDK 教程

使用Platform Web SDK数据设置事件转发

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • 初学者
  • 中级
  • 开发人员

了解如何使将事件转发功能与 Adobe Experience Platform Web SDK 数据一起使用。

事件转发是数据收集中可用的一种新属性。 事件转发让您能够直接从Adobe Experience PlatformEdge Network而不是传统的客户端浏览器向第三方非Adobe供应商发送数据。 在事件转发概述中进一步了解事件转发的优势。

Web SDK和事件转发图

要在Adobe Experience Platform中使用事件转发，必须首先使用以下三个选项中的一个或多个将数据发送到Adobe Experience PlatformEdge Network：

NOTE
Platform Web SDK和Platform Mobile SDK不需要通过标记进行部署，但是，建议使用标记来部署这些SDK。

完成本教程中之前的课程后，您应该使用Web SDK将数据发送到PlatformEdge Network。 数据进入平台Edge Network后，您可以启用事件转发并使用event-forwarding属性将数据发送到非Adobe解决方案。

学习目标

在本课程结束时，您将能够：

  • 创建事件转发属性
  • 将事件转发属性链接到Platform Web SDK数据流
  • 了解标记属性数据元素和规则与事件转发属性数据元素和规则之间的差异
  • 创建事件转发数据元素
  • 配置事件转发规则
  • 验证事件转发属性是否已成功发送数据

先决条件

创建事件转发属性

首先，创建事件转发属性：

  1. 打开数据收集接口

  2. 从左侧导航中选择​ 事件转发

  3. 选择​ 新属性。
    事件转发属性

  4. 命名资产。 在这种情况下，Server-Side - Web SDK Course

  5. 选择​ 保存。
    事件转发属性保存

配置数据流

要使事件转发使用您发送到PlatformEdge Network的数据，您必须将新创建的事件转发属性链接到用于将数据发送到Adobe解决方案的相同数据流。

要在数据流中配置Target，请执行以下操作：

  1. 转到数据收集接口

  2. 在左侧导航中，选择​ 数据流

  3. 选择之前创建的Luma Web SDK: Development Environment数据流

    选择Luma Web SDK数据流

  4. 选择​ 添加服务
    向数据流添加服务

  5. 选择​ 事件转发 ​作为​ 服务

  6. 在​ 属性ID ​下拉列表下，选择您为事件转发属性提供的名称，在本例中为Server-Side - Web SDK Course

  7. 在​ 环境ID ​下拉列表下，选择要将事件转发环境链接到的标记环境，在本例中为Development

    note tip
    TIP
    若要将数据发送到Adobe组织外部的事件转发环境，请选择​ 手动输入ID ​并粘贴到ID中。 此ID是在创建事件转发属性时提供的。

  8. 选择​ 保存。

    事件转发数据流启用

当您准备好通过发布流提升所做更改时，请为暂存和生产数据流重复这些步骤。

将数据从平台Edge Network转发到非Adobe解决方案

在本练习中，您将学习如何设置事件转发数据元素、配置事件转发规则，以及使用名为Webhook.site的第三方工具进行验证。

NOTE
webhook是一种半实时地集成不同系统的方法。 Webhook.site是第三方工具，可让您轻松检查、测试和自动化（使用可视化自定义操作生成器或WebhookScript）任何传入的HTTP请求或电子邮件。
IMPORTANT
您必须已创建数据元素并将其映射到XDM对象，且已配置标记规则并在库中将这些更改构建到标记环境才能继续。 如果没有，请参阅先决条件部分中的​ 标记配置 ​步骤。 这些步骤可确保将数据发送到PlatformEdge Network，并且您可从此处配置事件转发属性以将数据转发到非Adobe解决方案。

创建事件转发数据元素

您之前使用Platform Web SDK标记扩展配置的XDM对象将成为事件转发属性中数据元素的数据源。 您可以使用已在标记属性中配置的数据作为事件转发的数据源。

IMPORTANT
在事件转发中引用XDM字段与其他上下文时，有一个关键语法差异。 要在事件转发属性中引用数据，数据元素路径必须包含arc.event前缀：
  • 其中，arc 表示 Adobe 响应上下文。
  • 例如：arc.event.xdm.web.webPageDetails.URL
如果未正确指定此路径，则不会收集数据。

在本练习中，您要将浏览器视区高度和Experience CloudID从XDM对象转发到webhook。 XDM字段路径由配置XDM架构课程中创建的XDM架构确定。

TIP
您还可以通过使用Web浏览器网络工具、筛选/ee请求、打开信标​ 有效负载 并向下钻取到要查找的变量来查找XDM对象路径。 然后，使用鼠标右键单击并选择“复制属性路径”。 以下是浏览器视区高度的示例：
事件转发XDM路径

  1. 转到您最近创建的​ 事件转发 ​属性

  2. 在左侧导航中，选择​ 数据元素

  3. 选择以​ 创建新数据元素

    事件转发新数据元素

  4. 名称 ​数据元素environment.browserDetails.viewportHeight

  5. 在​ 扩展 ​下，离开CORE

  6. 在​ 数据元素类型 ​下，选择Path

  7. 键入包含浏览器视区高度arc.event.xdm.environment.browserDetails.viewportHeight的XDM对象路径

  8. 选择​ 保存

    事件转发ECID路径

  9. 创建另一个数据元素

  10. 名称，它ecid

  11. 在​ 扩展 ​下，离开CORE

  12. 在​ 数据元素类型 ​下，选择Path

  13. 键入包含Experience CloudID arc.event.xdm.identityMap.ECID.0.id的XDM对象路径

  14. 选择​ 保存

    事件转发ECID路径

    note caution
    CAUTION
    确保在路径中包含arc.event.前缀。 此外，请确保遵循与XDM对象字段名称完全相同的大小写 — ECID命名空间必须全部大写。
    note tip
    TIP
    使用您自己的网站时，您可以使用Web浏览器网络工具找到XDM对象路径，过滤/ee请求，打开信标​ 有效负载 并向下钻取到要查找的变量。 然后，使用鼠标右键单击并选择“复制属性路径”。 以下是浏览器视区高度的示例：
    事件转发XDM路径

安装Adobe云连接器扩展

若要将数据发送到第三方位置，您将首先安装Adobe云连接器扩展。

  1. 在左侧导航中选择​ 扩展

  2. 选择​ 目录 ​选项卡

  3. 搜索​ Adobe云连接器，选择​ 安装

    事件转发ECID路径

无需扩展配置。 通过此扩展，您现在可以将数据转发到非Adobe解决方案！

创建事件转发规则

配置标记属性中的规则与事件转发属性中的规则有一些主要区别：

  • 事件和条件：

    • 标记：所有规则均由必须在规则中指定的事件触发，例如Library Loaded - Page Top。 条件为可选。
    • 事件转发：假定每个发送到PlatformEdge Network的事件都是转发数据的触发器。 因此，在事件转发规则中不能选择事件。 要管理哪些事件会触发事件转发规则，您必须配置条件。

  • 数据元素标记化：

    • 标记：在规则中使用数据元素名称时，其开头和结尾分别使用%来标记数据元素名称。 例如：%viewportHeight%。

    • 事件转发：在规则中使用数据元素名称时，数据元素名称的开头以{{标记，结尾以}}标记。 例如：{{viewportHeight}}。

  • 规则操作序列：

    • 事件转发规则的“操作”部分始终按顺序执行。 保存规则时，请确保操作顺序正确。 无法像对标记执行操作一样异步执行此执行序列。

要配置用于将数据转发到webhook的规则，您必须先获取个人webhook：

  1. 转到Webhook.site

  2. 查找​ 您的唯一URL，在事件转发规则中将此作为URL请求

  3. 选择​ 复制到剪贴板

  4. 保持此窗口处于打开状态，因为您将能够验证Webhook实时捕获的事件转发数据

    复制Webhook URL

  5. 从左侧导航中返回​ 数据收集 > 事件转发 > 规则

  6. 选择​ 创建新规则

    事件转发新规则

  7. 将其命名为all events - ad cloud connector - webhook

  8. 添加操作

  9. 在​ 扩展 ​下，选择​ Adobe云连接器

  10. 在​ 操作类型 ​下，选择​ 发出获取调用

  11. 将Webhook URL粘贴到​ URL ​字段中

    复制Webhook URL

  12. 在​ [Query Params] ​下，您将添加之前创建的两个数据元素。

  13. 在viewPortHeight中的​ 键 ​列类型上。 在​ 值 ​列上，通过键入{{environment.browserDetails.viewportHeight}}数据元素或从数据元素选择器图标中进行选择来输入该数据元素

  14. 选择​ +添加另一个 ​以添加另一个查询参数

  15. 在ecid中的​ 键 ​列类型上。 在值列中，输入{{ecid}}数据元素

  16. 选择​ 保留更改

    添加查询参数

  17. 您的规则应如下所示

  18. 选择​ 保存

    保存事件转发规则

创建并生成库

创建一个库并生成对事件转发开发环境的所有更改，就像在标记属性中通常所做的那样。

NOTE
如果尚未将暂存和生产事件转发属性链接到数据流，则您将看到开发环境作为生成库的唯一选项。

保存事件转发规则

验证事件转发规则

现在，您可以使用Platform Debugger和Webhook.site验证事件转发属性：

  1. 按照以下步骤🔗将Luma演示网站上的标记库切换到您在数据流中映射了事件转发属性的Web SDK标记属性。

  2. 在重新加载页面之前，在Experience Platform调试器上，从左侧导航中打开​ 日志

  3. 选择​ Edge ​选项卡，然后选择​ 连接 ​以查看PlatformEdge Network请求

    事件转发边缘网络会话

  4. 重新加载页面

  5. 您将看到其他请求，这些请求使您能够了解平台Edge Network发送到WebHook的服务器端请求

  6. 需要重点验证的请求是显示由Edge网络发送的完全构建的URL的请求

    事件转发调试器

  7. 请注意viewPortHeight和ecid查询字符串参数

    事件转发验证查询字符串

  8. 它们与XDM对象中看到的数据匹配

    事件转发匹配数据

  9. 最后，通过查看打开的Webhook窗口来验证Webhook.site中的数据匹配

    事件转发webhook站点数据

恭喜！您已配置事件转发！

下一步：

NOTE
感谢您投入时间学习Adobe Experience Platform Web SDK。 如果您有疑问、希望分享一般反馈或有关于未来内容的建议，请在此Experience League社区讨论帖子上分享这些内容
recommendation-more-help
8cbc0fd8-ca1d-433b-9c3d-bc3f113347d4