開發人員快速入門 get-started-developers

在此頁面上:​實施 SDK、事件串流、自訂動作端點,以及可將應用程式連接到 Adobe Journey Optimizer 的 API,讓您的歷程能根據即時資料執行。

身為​開發人員,您負責實作 Adobe Journey Optimizer 並將其整合至您的應用程式與系統。 一旦系統管理員資料工程師授予您存取權限並準備好您的環境,您就可以開始使用 Adobe Journey Optimizer。

NOTE
實作順序: 管理員資料工程師 → 您在這裡:開發人員行銷人員
實施行動和網頁整合之前,請確定已設定資料結構描述和事件

您在 Journey Optimizer 生態系統中的角色

其他團隊成員透過使用者介面設定 Journey Optimizer 時,您將專注於:

  • 在行動應用程式和網頁應用程式中​實作 SDK
  • 從您的應用程式​ 傳送事件 ​以觸發歷程
  • 建立 API 端點,Journey Optimizer 可透過自訂動作呼叫此端點
  • 整合 Journey Optimizer 與您現有的系統和基礎結構
  • 測試和偵錯​您的實作

您的資料工程師將處理資料結構描述、事件設定和資料來源。 您的管理員將設定權限和管道設定。 行銷人員將設計使用您實作的歷程和內容。

本指南涵蓋基本技術實作步驟,以協助您快速入門 Journey Optimizer。 無論您是建立行動應用程式、網頁體驗還是 API 整合,請遵循以下區段來設定您的實作。

先決條件 prerequisites

在開始實作之前,請確定您擁有:

類別
需求
技術技能
* 使用 JavaScript (適用於 Web SDK) 或 Swift/Kotlin (適用於 Mobile SDK) 的經驗
* 了解 RESTful API 和 JSON
* 熟悉非同步程式設計和事件導向架構
* 了解貴組織的應用程式架構
存取權與工具
* Adobe Developer Console 的存取權,以取得 API 認證
* 開發環境,以及應用程式程式碼庫的存取權
* 測試工具,例如 Postman 以進行 API 測試
* 瀏覽器開發人員工具或行動偵錯工具
來自其他團隊成員
您的管理員
授予的環境存取權
來自資料工程師
的 XDM 結構描述和事件定義* 來自行銷人員的需求和使用案例

了解技術基礎 technical-foundation

開始實作前,請先熟悉核心技術概念:

  1. Adobe Experience Platform 整合:Journey Optimizer 原生建立在 Adobe Experience Platform 上。 了解基礎架構將幫助您建立更有效的實作。 深入了解 Journey Optimizer 的運作方式

  2. XDM 資料模型:Journey Optimizer 使用體驗資料模型 (XDM) 來建構事件和輪廓資料。 身為開發人員,您必須了解如何傳送符合資料工程師所設定之結構描述的資料。 了解 XDM 結構描述

  3. 驗證和安全性:所有實作都需要正確的驗證。 了解如何設定 SDK 和 API 的驗證。 了解 API 驗證

設定行動應用程式整合 mobile-integration

設定 Adobe Experience Platform Mobile SDK

行動 SDK 是您直接內嵌在 iOS 或 Android 應用程式中的程式庫集合。 它可作為應用程式與 Adobe Experience Platform 之間的通訊層:可識別使用者、收集行為事件,並從 Journey Optimizer 提供指示,包括推播通知、應用程式內訊息和個人化內容。 若沒有它,Journey Optimizer 就無法得知您的應用程式使用者在做什麼,也無法聯絡上他們。

  1. 安裝及設定 Mobile SDK:請依照 Adobe Experience Platform Mobile SDK 文件操作,開始進行 SDK 整合。

  2. 建立行動屬性:在 Adobe Experience Platform Data Collection 中設定行動屬性。 了解如何建立和設定行動屬性

  3. 設定推播通知

    • 針對 iOS 應用程式:向 APN (Apple 推播通知服務) 註冊您的應用程式。 若要了解更多資訊,請參閱 Apple 文件
    • 針對 Android 應用程式:為您的 Android 應用程式設定 Firebase 雲端訊息。 若要了解更多資訊,請參閱 Google 文件
  4. 測試您的行動整合:使用行動快速入門工作流程來快速設定並測試您的行動設定。

設定推播通知的詳細步驟可在此頁面上取得。

實作程式碼型體驗 (Mobile SDK)

程式碼型體驗可讓您向原生行動應用程式中的任何表面提供個人化內容 (從入門畫面和產品詳細資料頁面,到應用程式內橫幅和功能標幟),而不需要新的應用程式版本。 使用 Mobile SDK 在執行階段擷取及呈現個人化內容,讓您的團隊可完全掌控版位和呈現方式:

實作網頁體驗 web-implementation

設定 Adobe Experience Platform Web SDK

Web SDK (alloy.js) 是單一 JavaScript 程式庫,可取代您網站原本可能需要的零散 Adobe 標籤。 它會收集行為資料、透過您設定的資料流將其串流至 Adobe Experience Platform,並接收回傳的個人化指示,所有這些都在一個網路往返中。 設定完成後,Journey Optimizer 就可以識別訪客、從他們的動作觸發歷程,並立即將自訂內容提供給您的頁面。

  1. 安裝 Web SDK:請依照 Web SDK 實作指南操作,在您的網站上設定 SDK。

  2. 設定資料流:啟用 Journey Optimizer 後,在 Adobe Experience Platform Data Collection 中建立並設定資料串流。 在資料流文件中了解更多相關資訊。

  3. 啟用網頁推播通知 (選用):網頁推播通知現在一般可用。 在您的 Web SDK 設定中設定 pushNotifications 屬性,並使用 sendPushSubscription 命令來註冊推播訂閱。 瞭解網頁推播設定

實作程式碼型體驗 (Web SDK)

不同於行銷人員完全控制版面的視覺管道,程式碼型體驗可讓您完全掌控個人化內容在頁面上的呈現方式。 Journey Optimizer 會傳回包含個人化資料的 JSON 承載;您的程式碼會決定要在哪裡以及如何顯示。 此模型適用於任何網路介面 (英雄橫幅、建議輪播、搜尋結果排名、A/B 測試變體),而無需視覺化編輯器或頁面發佈工作流程。

  1. 選擇您的實作方法:用戶端、伺服器端或混合式。 檢閱每個方法的實作範例

  2. 定義表面:識別您要在應用程式中傳遞個人化內容的位置。 了解表面設定

  3. 實作內容轉譯:使用 Web SDK 擷取並套用個人化內容。 請參閱程式碼型實作教學課程

  4. 傳送顯示和互動事件:追蹤內容顯示的時間以及使用者與內容互動以進行分析和最佳化的時間。

探索 GitHub 上的範例實作,了解程式碼型體驗的實際運作情況。

深入了解程式碼型體驗快速入門

實作事件串流 event-streaming

傳送事件以觸發歷程

歷程會根據事件執行 — 使用者登入、將商品加入購物車、完成購買、放棄表單。 您的工作是在正確的時間從應用程式發出這些事件。 每個事件都是傳送至 Experience Platform 串流攝取 API 的 XDM 結構化 JSON 承載;Journey Optimizer 會在毫秒內攝取該事件,並將輪廓路由至任何相符歷程。 事件結構描述和承載結構是由您的資料工程師所定義,在您開始編碼之前先與其協調。

  1. 了解事件承載:請與您的資料工程師合作,取得事件結構描述和必要的承載結構。 承載必須符合其所設定的 XDM 結構描述。 了解事件結構描述需求

  2. 實作事件串流:使用串流擷取 API 將事件傳送至 Adobe Experience Platform。 了解傳送事件的步驟

  3. 處理事件類型

    • 單一事件:針對個人特定動作實作事件傳送 (例如,按鈕點按、購買完成)
    • 業務事件:傳送業務相關事件 (例如,庫存更新、價格變更)
  4. 測試事件傳送:確認事件已正確接收,並如預期觸發歷程。 了解事件疑難排解

透過 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

當歷程達到自訂動作步驟時,Journey Optimizer 會對您提供的URL (您的後端、CRM、忠誠度平台、任何 REST 端點) 發出傳出 HTTP 呼叫。 您的工作是建置並公開該端點:定義請求合約 (承載形狀、驗證方法、回應格式)、實作其背後的商業邏輯,並確保其可處理 Journey Optimizer 將產生的呼叫量。 您的管理員接著會在 Journey Optimizer 中註冊端點,讓行銷人員可以將其用作其歷程中的步驟。

  1. 建立您的 API 端點:建立 Journey Optimizer 將在歷程執行期間呼叫的 RESTful API 端點。 您的端點應:

    • 接受 JSON 承載
    • 驗證請求 (OAuth、API 金鑰或 JWT)
    • 在適當的逾時限制內處理請求
    • 以預期格式傳回回應
  2. 了解自訂動作功能:自訂動作可以連線至第三方系統,例如 Epsilon、Slack、Firebase 或您自己的服務。 深入了解自訂動作

  3. 使用動作設定:您的管理員資料工程師將在 Journey Optimizer 中設定自訂動作,定義 API 端點 URL、驗證方法和參數。 您將為他們提供您的 API 規格。 了解自訂動作設定。 您可以為逾時/錯誤分支中更豐富的邏輯定義選用的​錯誤回應承載

  4. 傳回可操作資料:設計您的 API 以傳回可用於後續歷程步驟的資料。 了解動作回應

  5. 監視自訂動作健康情況:使用自訂動作監視儀表板來追蹤成功的呼叫、錯誤、輸送量、回應時間和佇列等待時間。 瞭解自訂動作報告

  6. 實作速率限制:確保您的端點可以處理預期的流量。 Journey Optimizer 套用每秒 5000 次呼叫的限制,但您的系統應可復原。 了解上限與節流

範例使用案例:使用自訂動作將歷程事件寫入 Experience Platform

使用 Journey Optimizer API apis

並非所有事情都需要透過 Journey Optimizer UI 完成。 有時您需要從自己的後端觸發行銷活動、在隱私權請求後抑制電子郵件地址,或從外部 CMS 同步內容範本。 Journey Optimizer 的 REST API 可讓您以程式設計方式存取平台的核心功能。 所有呼叫都使用 OAuth 伺服器對伺服器驗證,舊版 JWT 方法已淘汰。

  1. 了解 API 功能:Journey Optimizer API 可讓您以程式設計方式建立、讀取、更新和刪除各種資源。 深入了解 Journey Optimizer API

  2. 驗證:請依照本教學課程中的指示,使用 Adobe Developer Console 設定 API 驗證。

  3. 探索 API 參考:瀏覽完整的 API 文件,並直接在 Adobe Journey Optimizer API 參考中試用 API。

  4. API 觸發的行銷活動:使用 API 觸發的行銷活動建立交易型訊息。 若是高流量案例 (最多5000 TPS),請探索高輸送量模式 (需要附加授權)。

  5. 決策管理 API:使用專門的 API 進行產品建議管理和決策。 若要了解更多資訊,請參閱決策管理 API 指南

  6. 決策移轉 API:以程式設計方式將決策管理實體移轉至具有彈性範圍、自動化驗證和復原支援的決策。 若要瞭解更多資訊,請參閱決策移轉 API 指南

  7. 簡訊 Webhook:設定傳入 Webhook 以擷取傳入訊息和意見回饋 Webhook,以便接收傳遞回條和狀態更新。 了解更多

測試和偵錯 testing

在實施正式上線之前,您需要確信事件會在正確時機引發、歷程會如預期觸發、自訂動作能在真實負載下運作,且個人化內容會正確呈現。 本節介紹可及早發現問題的工具與技巧,涵蓋從底層 SDK 記錄,到使用真實輪廓進行端到端歷程測試執行。

  1. 偵錯 SDK 實施:使用 Adobe Experience Platform Assurance 即時檢查 SDK 事件、驗證資料收集,並疑難排解整合問題。 深入了解 Assurance

  2. 測試事件傳送:確認 Adobe Experience Platform 已正確接收來自您應用程式的事件,並如預期觸發歷程。 監視事件擷取並驗證承載結構。

  3. 驗證 API 整合:測試您的自訂動作端點,以確保它們可正確處理 Journey Optimizer 請求、在逾時限制內回應,以及傳回預期的資料格式。

  4. 搭配測試輪廓使用測試模式:與您的資料工程師合作,存取測試輪廓,然後使用歷程測試模式驗證您的實作。 了解如何測試歷程

  5. 監視 SDK 記錄:在您的 SDK 實作中啟用偵錯記錄,以疑難排解開發期間的問題:

    • Mobile SDK:啟用記錄以檢視 SDK 事件和 API 呼叫
    • Web SDK:使用瀏覽器控制台監視 SDK 活動
  6. 驗證資料流設定:確定您的資料流已正確設定為傳送資料至 Journey Optimizer。 檢查事件是否流經資料流到達正確的目的地。

  7. 查詢歷程資料以進行分析:使用資料湖上的 SQL 查詢來分析歷程步驟事件、偵錯問題,以及監視自訂動作績效。 探索歷程分析的查詢範例,包括:

    • 輪廓進入/退出追蹤與捨棄原因
    • 自訂動作績效量度 (延遲、輸送量、錯誤)
    • 事件傳送和錯誤模式
    • 歷程執行個體狀態

進階開發人員主題 advanced-topics

一旦核心 SDK、事件和 API 就緒,這些主題可協助您更進一步:在執行階段豐富歷程資料,而不讓設定檔膨脹;處理同意訊號,讓選擇退出狀態傳播到每個整合;並調整實作,以滿足生產規模所需的輸送量和可靠性。

使用內容資料及擴充

歷程通常需要比觸發事件傳入的資料更多,例如產品名稱、忠誠度等級或訂單明細項目清單。 與其將所有這些資料預先載入每個輪廓,情境擴充可讓歷程在執行階段從 AEP 資料集查詢資料,或從自訂動作回應中延續該資料。 接著,您的訊息和分支條件即可參照該資料,而不必將其永久儲存在輪廓中。

  • 反覆處理陣列:使用 Handlebars 語法在訊息中顯示來自事件、自訂動作回應和資料集查詢的動態清單。 了解如何反覆處理內容資料
  • 資料集查詢:實作資料集查詢,以擴充 Adobe Experience Platform 資料集的歷程資料。 與您的資料工程師共同處理設定。 了解資料集查詢

使用同意與治理

Journey Optimizer 會在平台層級強制執行資料治理和同意原則,但您的整合也必須遵守這些原則。 當客戶選擇退出行銷通訊,或資料使用標籤限制某個欄位的使用方式時,這些規則必須傳播到您的自訂動作和資料集查詢中,而不只是封鎖 UI 中的動作。

  • 資料治理:將資料使用原則套用至自訂動作。 深入了解資料治理
  • 同意管理:在您的實作中處理客戶同意偏好設定。 了解同意

最佳化和最佳做法

生產環境中的 Journey Optimizer 實施通常會處理每秒數百萬個事件和數千次歷程執行。 這些資源可協助您針對這種規模調整整合:在觸及速率限制前先了解限制,避開會悄悄捨棄設定檔的常見歷程設計陷阱,並建立可優雅降級而非不明原因失敗的錯誤處理機制。

呼叫 Journey Optimizer REST API rest-apis

除了實施 SDK 和事件串流之外,您也可以從自己的系統以程式設計方式驅動 Journey Optimizer。 完整的 API 參考、OpenAPI 規格和程式碼範例可在 Journey Optimizer 開發人員入口網站取得。

NOTE
所有整合都必須使用 OAuth 伺服器對伺服器驗證,JWT 方法已淘汰。 設定驗證

執行 API 觸發的行銷活動 api-triggered

使用互動式訊息執行 REST API,從外部系統觸發交易型或行銷訊息。 呼叫端點之前:

  • 端點接受呼叫之前,行銷活動必須​啟用
  • 呼叫有 60 秒逾時;內部重試會處理非預期的逾時。
  • 如果設定了行銷活動的開始/結束日期,則這些日期以外的 API 呼叫將失敗。
  • 若要建置裝載,請在 Journey Optimizer UI 中,從即時行銷活動的 cURL 請求​區段檢索產生的範例 cURL 請求,其中包含該行銷活動的所有個人化變數。
  • 標準行銷活動和高輸送量行銷活動使用不同的端點。

API 參考 · 程式碼範例 · 使用 API 觸發的行銷活動

外部端點的上限和節流 capping-throttling

當歷程透過自訂動作或資料來源呼叫外部系統時,上限和節流 API 可保護這些系統免於過載。 上限會拒絕超過設定限制的呼叫;節流會將這些呼叫排入佇列,最多 6 小時 (僅限生產沙箱和自訂動作)。

上限 API 參考 · 使用上限 API · 使用節流 API

更多 REST API more-rest-apis

除了傳訊和上限之外,Journey Optimizer 還提供 REST 端點,用於抑制管理、內容範本化、行銷活動檢索、校樣和協調式行銷活動執行。 當您需要自動化操作時,請使用這些選項,否則UI中需要手動步驟,例如,拉取資料後大量隱藏位址,或從外部內容管道同步範本。

需要執行的事項
API 參考
以程式設計方式排除電子郵件地址或網域,避免向其傳送郵件
禁止名單 API · 管理禁止名單
檢索歷程中繼資料以進行稽核或外部同步
歷程 API
從外部管道建立和管理內容範本和片段
內容 API · 範本 · 片段
檢索及篩選動作行銷活動
行銷活動 API
預覽行銷活動並以程式設計方式傳送校樣
模擬 API
NOTE
模擬 API 可用於 API 觸發和動作 (已排程) 行銷活動。 協調行銷活動不支援:請改用協調行銷活動使用者介面中的預覽和校訂工作流程來進行。

|驗證資料集並觸發協調的行銷活動執行 | 資料集驗證 · 觸發器 · 啟用資料集 |

其他資源 additional-resources

跨角色共同作業 next-steps

您的實作工作與其他團隊成員的工作有交集:

與資料工程師合作

資料工程師共同處理資料與事件設定。 每個對使用者行為回應的歷程都取決於您傳送的事件,資料工程師會定義結構,您實施產生結構的程式碼。

與管理員合作

管理員共同處理存取權和頻道設定。 歷程只能透過管理員設定的管道觸及使用者,及早協調,讓您的 SDK 運作及其設定保持同步。

與行銷人員合作

行銷人員共同進行歷程設計和測試。 行銷人員建立的歷程和內容完全取決於您傳送的事件和公開的表面,您對齊得越緊密,歷程就越快上線。

開始實作

準備好開始建立了嗎? 從以上區段選擇您的第一個實作區域:

  1. 行動應用程式? 開始進行 Mobile SDK 整合
  2. 網站? 開始設定 Web SDK
  3. API 整合? 跳轉至使用 API
  4. 自訂系統? 查看自訂動作

每個區段都包含詳細技術文件、程式碼範例和教學課程的連結,以指導您的實作。

其他角色指南 other-role-guides

角色
指南
管理員
管理員快速入門
資料工程師
資料工程師快速入門
Developer
開發人員快速入門
行銷人員
行銷人員快速入門

返回角色和職責總覽 · 返回快速入門

AI Knowledge Reference

This section contains structured knowledge intended to support interpretation, retrieval, and question answering related to this topic.

For complete understanding, this information should be combined with the documentation on this page. Neither source is intended to stand alone; the page describes the feature, while this section provides additional context that helps disambiguate terminology, intent, applicability, and constraints.

  • TL;DR: This page is the Developer getting-started path, covering how to implement the Mobile and Web SDKs, event streaming, custom action endpoints, and Journey Optimizer REST APIs, then test and debug those integrations.

Intents:

  • Set up Adobe Experience Platform Mobile SDK and Web SDK integrations
  • Implement code-based experiences for mobile and web surfaces
  • Send events to trigger journeys using the Streaming Ingestion APIs
  • Develop custom action endpoints that Journey Optimizer calls during journey execution
  • Work with Journey Optimizer REST APIs, including API-triggered campaigns and capping and throttling
  • Test and debug implementations using test mode with test profiles and Adobe Experience Platform Assurance

Glossary:

  • Mobile SDK: A collection of libraries embedded in an iOS or Android app that identifies users, collects behavioral events, and delivers instructions from Journey Optimizer (product-specific)
  • Web SDK (alloy.js): A single JavaScript library that collects behavioral data, streams it to Adobe Experience Platform through a datastream, and receives personalization instructions back (product-specific)
  • Custom action: A journey step where Journey Optimizer makes an outbound HTTP call to a URL you provide, such as a backend, CRM, or loyalty platform (product-specific)
  • Code-based experiences: Personalized content delivered to any mobile or web surface, where Journey Optimizer returns a JSON payload and your code decides where and how to display it (product-specific)
  • Unitary events: Person-specific action events (for example a button click or purchase completion), as distinct from business events such as inventory updates or price changes (product-specific)

Guardrails:

  • Journey Optimizer applies a 5000 calls/second limit for custom action endpoints, but your system should be resilient.
  • API-triggered campaign calls have a timeout of 60 seconds; internal retries handle unexpected timeouts.
  • An API-triggered campaign must be activated before the endpoint accepts calls, and calls made outside configured campaign start and end dates will fail.
  • Throttling queues calls for up to 6 hours (production sandboxes, custom actions only), while capping rejects calls that exceed the configured limit.
  • High Throughput mode for API-triggered campaigns supports up to 5000 TPS and requires an add-on license.
  • All integrations must use OAuth Server-to-Server authentication; the JWT method is deprecated.
  • The Simulations API is available for API-triggered and Action (scheduled) campaigns and is not supported for Orchestrated campaigns.

Terminology:

  • Canonical name: Developer — variants: Developer getting-started path
  • Acronyms: SDK = Software Development Kit; XDM = Adobe Experience Data Model; TPS = transactions per second; API = Application Programming Interface
  • Implementation order: Administrator → Data Engineer → Developer → Marketer
  • Do not confuse: “Mobile SDK” (embedded iOS or Android libraries) ≠ “Web SDK” (alloy.js JavaScript library)
  • Do not confuse: “Capping” (rejects calls that exceed the configured limit) ≠ “Throttling” (queues calls for up to 6 hours)

FAQ:

  • Q: What is the rate limit for custom action endpoints? — Journey Optimizer applies a 5000 calls/second limit, but your endpoints should still be resilient.
  • Q: Which authentication method must API integrations use? — OAuth Server-to-Server authentication; the JWT method is deprecated.
  • Q: What must be true before an API-triggered campaign endpoint accepts calls? — The campaign must be activated, and calls outside any configured start and end dates will fail.
  • Q: What is the difference between capping and throttling? — Capping rejects calls that exceed the configured limit, while throttling queues them for up to 6 hours (production sandboxes, custom actions only).
  • Q: Is the Simulations API supported for Orchestrated campaigns? — No; it is available for API-triggered and Action (scheduled) campaigns, and you use the preview and proof workflow in the Orchestrated campaigns user interface instead.
  • Q: How do I test my implementation before it goes live? — Use test mode with test profiles obtained from your Data Engineer, and use Adobe Experience Platform Assurance to inspect SDK events and troubleshoot.
recommendation-more-help
journey-optimizer-help