开发人员入门 get-started-developers
作为开发人员,您负责将Adobe Journey Optimizer实施并集成到您的应用和系统中。系统管理员和数据工程师为您授予访问权限并准备好环境后,您就可以开始使用 Adobe Journey Optimizer。
您在 Journey Optimizer 生态系统中的角色
当其他团队成员通过用户界面配置 Journey Optimizer 时,您将专注于以下方面:
- 在移动端和 web 应用中实现 SDK
- 从您的应用程序 发送事件 以触发历程
- 构建 API 端点供 Journey Optimizer 通过自定义操作调用
- 将 Journey Optimizer 与您现有的系统和基础设施集成
- 测试和调试您的实现内容
您的数据工程师将处理数据架构、事件配置和数据源。您的管理员将设置权限和渠道配置。营销人员将设计使用您所实现的历程与内容。
本指南涵盖必要的技术实施步骤,助您开始使用 Journey Optimizer。无论您是构建移动应用程序、web 体验还是 API 集成,请按照以下部分设置您的实施内容。
先决条件 prerequisites
在开始实施之前,请确保您具备以下条件:
* 了解 RESTful API 和 JSON
* 熟悉异步编程和事件驱动型架构
* 了解您所在组织的应用架构
理解技术基础 technical-foundation
在深入实施之前,请先熟悉以下核心技术概念:
-
Adobe Experience Platform 集成:Journey Optimizer 原生构建于 Adobe Experience Platform 之上。理解其底层架构将帮助您构建更高效的实施方案。进一步了解 Journey Optimizer 的工作原理。
-
XDM 数据模型:Journey Optimizer 使用体验数据模型 (XDM) 来构建事件和轮廓数据的结构。作为开发人员,您需要了解如何发送符合数据工程师配置的数据架构的数据。了解 XDM 架构。
-
身份验证和安全性:所有实施都需要进行适当的认证。了解如何为 SDK 和 API 设置身份验证。了解 API 身份验证。
设置移动应用集成 mobile-integration
配置 Adobe Experience Platform Mobile SDK
要启用推送通知、应用程序内消息和其他移动端功能,请将 Adobe Experience Platform Mobile SDK 集成到您的移动应用程序中。
-
安装和配置 Mobile SDK:按照Adobe Experience Platform Mobile SDK 文档操作,开始进行 SDK 集成。
-
创建移动属性:在 Adobe Experience Platform Data Collection 中设置移动属性。了解如何创建和配置移动属性。
-
配置推送通知:
-
测试您的移动端集成:使用移动端快速启动工作流来高效配置和测试您的移动端设置。
此页面提供了配置推送通知的详细步骤。
实施基于代码的体验 (Mobile SDK)
若要通过基于代码的体验实现原生移动应用个性化:
实施 web 体验 web-implementation
设置 Adobe Experience Platform Web SDK
对于基于 web 的实施,Web SDK 是您的主要集成点:
-
安装 Web SDK:按照 Web SDK 实施指南在您的网站上设置 SDK。
-
配置数据流:在 Adobe Experience Platform Data Collection 中创建并配置启用了 Journey Optimizer 的数据流。有关更多信息,请参阅数据流文档。
-
启用 Web 推送通知(可选):在 Web SDK 配置中配置 pushNotifications 属性,并使用 sendPushSubscription 命令注册推送订阅。
实施基于代码的体验 (Web SDK)
基于代码的体验允许您个性化任何数字接触点:
浏览 ](https://github.com/adobe/alloy-samples/tree/main/ajo){target=“_blank”}GitHub 上的实施示例[,了解实际应用中的基于代码的体验。
进一步了解基于代码的体验快速入门。
实施事件流 event-streaming
发送事件以触发历程
作为开发人员,您需要编写代码以发送触发历程的事件。您的数据工程师将在 Journey Optimizer 中配置事件架构和定义。
-
了解事件负载:与您的数据工程师协作,获取事件架构及所需的负载结构。负载必须符合其配置的 XDM 架构。了解事件架构要求。
-
实施事件流:使用流式数据摄取 API 将事件发送至 Adobe Experience Platform。了解发送事件的步骤。
-
处理事件类型:
- 单一事件:针对特定用户的操作(例如按钮点击、购买完成)实现事件发送
- 业务事件:发送业务相关事件(例如库存更新、价格变更)
-
测试事件传递:验证事件是否被正确接收并按预期触发客户历程。了解事件故障排除。
通过 API 发送事件的实施示例:
POST https://{DATACOLLECTION_ENDPOINT}/collection/{DATASTREAM_ID}
Content-Type: application/json
{
"header": {
"datasetId": "{DATASET_ID}",
"imsOrgId": "{ORG_ID}",
"source": {
"name": "Web SDK"
}
},
"body": {
"xdmMeta": {
"schemaRef": {
"id": "{SCHEMA_ID}"
}
},
"xdmEntity": {
"_id": "unique-event-id",
"eventType": "purchase",
"timestamp": "2024-01-01T12:00:00Z",
// ... your event data
}
}
}
进一步了解处理历程事件。
开发自定义操作端点 custom-actions
自定义操作允许历程调用您的 API。作为开发人员,您将构建供自定义操作调用的 API 端点:
-
构建您的 API 端点:创建 RESTful API 端点,供 Journey Optimizer 在历程执行期间调用。您的端点应:
- 接受 JSON 负载
- 身份验证请求(OAuth、API 密钥或 JWT)
- 在适当的超时限制内处理请求
- 以预期格式返回响应
-
了解自定义操作功能:自定义操作可以连接到第三方系统,如 Epsilon、Slack、Firebase 或您自己的服务。详细了解自定义操作。
-
使用操作配置:您的管理员或数据工程师将在 Journey Optimizer 中配置自定义操作,定义 API 端点 URL、身份验证方法和参数。您将向他们提供您的 API 规范。了解自定义操作配置。
-
返回可操作数据:设计您的 API 以返回可在后续历程步骤中使用的数据。了解操作响应。
-
实现速率限制:确保您的端点能够处理预期的请求量。Journey Optimizer 设有 5000 次/秒的调用限制,但您的系统应具备一定弹性。了解上限和限制。
示例用例:使用自定义操作将历程事件写入 Experience Platform。
使用 Journey Optimizer API apis
Journey Optimizer 提供了全面的 REST API,支持通过编程方式访问:
-
了解 API 功能: Journey Optimizer API 允许您以编程方式创建、读取、更新和删除各种资源。了解 Journey Optimizer API。
-
身份验证:按照本教程,使用 Adobe Developer Console 设置 API 身份验证。
-
浏览 API 参考文档:浏览完整的 API 文档,并直接在 Adobe Journey Optimizer API 参考中尝试 API 调用。
-
API 触发的营销活动:通过 API 触发的营销活动构建交易型消息。针对高流量场景(最高可达 5000 TPS),可探索使用高吞吐量模式(需要附加许可证)。
-
决策管理 API:使用专门的 API 进行产品建议管理和决策。在决策管理 API 指南中了解更多信息。
测试与调试 testing
-
调试 SDK 实施:使用 Adobe Experience Platform Assurance 检查 SDK 事件、验证数据收集并实时排查集成问题。进一步了解 Assurance。
-
测试事件传递:验证您应用程序发出的事件是否被 Adobe Experience Platform 正确接收并按预期触发历程。监控事件摄取过程并验证有效负载结构。
-
验证 API 集成:测试您的自定义操作端点,以确保其能正确处理 Journey Optimizer 请求、在超时限制内响应,并返回预期的数据格式。
-
监控 SDK 日志:在您的 SDK 实现中启用调试日志记录,以便在开发期间排查问题:
- Mobile SDK:启用日志记录以查看 SDK 事件和 API 调用
- Web SDK:使用浏览器控制台监控 SDK 活动
-
验证数据流配置:确保您的数据流已正确配置,可将数据发送至 Journey Optimizer。检查事件是否通过数据流传递至正确的目标位置。
-
查询历程数据以供分析:在数据湖上使用 SQL 查询来分析历程步骤事件、调试问题并监控自定义操作性能。探索用于历程分析的查询示例,包括:
- 轮廓进入/退出追踪和丢弃原因分析
- 自定义操作性能指标(延迟、吞吐量、错误率)
- 事件交付和错误模式
- 历程实例状态
高级开发人员主题 advanced-topics
处理上下文数据和扩充
处理同意与治理
在集成中实施数据治理和同意策略:
优化与最佳实践
其他资源 additional-resources
- Developer Console:访问 Adobe Developer Console 以创建集成并管理 API 凭据。
- 示例代码:浏览 GitHub 上的实施示例。
- 视频教程:通过 Experience League 上的实践教程进行学习。
- 开发人员社区:与其他开发人员联系,并在 Adobe 社区论坛中获取支持。
跨角色协作 next-steps
您的实施工作与其他团队成员相互关联:
开始实施
准备好开始构建了吗?从以上部分中选择您的首个实施领域:
- 移动应用程序?从 Mobile SDK 集成开始
- 网站?从 Web SDK 设置开始
- API 集成?跳转到使用 API 部分
- 自定义系统?查看自定义操作
每个部分都包含指向详细技术文档、代码示例和教程的链接,以指导您的实施工作。