開発者向けの基礎知識 get-started-developers
開発者は、Adobe Journey Optimizer をアプリケーションやシステムに実装し、統合する責任を負います。システム管理者とデータエンジニアからアクセス権を付与され、環境の準備ができたら、Adobe Journey Optimizer での作業を開始できます。
Journey Optimizer エコシステムでの役割
他のチームメンバーがユーザーインターフェイスを通じて Journey Optimizer を設定している間、以下に焦点を当てます。
- モバイルアプリケーションと web アプリケーションでの SDK の実装
- ジャーニーをトリガーするためのアプリケーションからのイベントの送信
- カスタムアクションを通じて Journey Optimizer が呼び出せる API エンドポイントの作成
- Journey Optimizer と既存のシステムおよびインフラストラクチャとの統合
- 実装のテストとデバッグ
データエンジニアは、データスキーマ、イベント設定およびデータソースを処理します。管理者は、権限とチャネル設定を指定します。マーケターは、実装を使用するジャーニーとコンテンツをデザインします。
このガイドでは、Journey Optimizer を開始するための基本的な技術的実装手順について説明します。モバイルアプリ、web エクスペリエンス、API 統合のいずれを作成する場合でも、以下の節に従って実装を設定してください。
前提条件 prerequisites
実装を開始する前に、以下の点を確認してください。
* RESTful API と JSON に関する理解
* 非同期プログラミングとイベント駆動型アーキテクチャに関する知識
* 組織のアプリケーションアーキテクチャに関する知識
* アプリケーションのコードベースへのアクセス権がある開発環境
* API テスト用の Postman などのテストツール
* ブラウザー開発者ツールまたはモバイルデバッグツール
技術的な基盤について 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 でモバイルプロパティを設定します。詳しくは、モバイルプロパティの作成と設定方法を参照してください。
-
プッシュ通知を設定:
- iOS アプリの場合:アプリを APNs(Apple プッシュ通知サービス)に登録します。詳しくは、Apple のドキュメントを参照してください。
- Android アプリの場合:Android アプリに Firebase Cloud Messaging を設定します。詳しくは、Google のドキュメントを参照してください。
-
モバイル統合をテスト:モバイルオンボーディングのクイックスタートワークフローを使用して、モバイル設定を迅速に設定およびテストします。
プッシュ通知を設定する手順について詳しくは、このページを参照してください。
コードベースのエクスペリエンスの実装(Mobile SDK)
コードベースのエクスペリエンスを使用したネイティブモバイルアプリのパーソナライゼーションの場合:
Web エクスペリエンスの実装 web-implementation
Adobe Experience Platform Web SDK の設定
Web ベースの実装の場合、Web SDK が主な統合ポイントです。
-
Web SDK をインストール:Web SDK 実装ガイドに従って、web サイトに SDK を設定します。
-
データストリームを設定:Journey Optimizer を有効にして、Adobe Experience Platform Data Collection でデータストリームを作成および設定します。詳しくは、データストリームドキュメントを参照してください。
-
Web プッシュ通知を有効にする(オプション):Web SDK 設定で pushNotifications プロパティを設定し、sendPushSubscription コマンドを使用してプッシュ購読を登録します。
コードベースのエクスペリエンスの実装(Web SDK)
コードベースのエクスペリエンスを使用すると、任意のデジタルタッチポイントをパーソナライズできます。
-
実装方法を選択:クライアントサイド、サーバーサイド、ハイブリッド。各アプローチの実装サンプルを確認します。
-
サーフェスを定義:パーソナライズされたコンテンツを配信するアプリケーション内の場所を特定します。詳しくは、サーフェスの設定を参照してください。
-
コンテンツレンダリングを実装:Web SDK を使用して、パーソナライゼーションコンテンツを取得および適用します。コードベースの実装チュートリアルを参照してください。
-
表示イベントとインタラクションイベントを送信:コンテンツが表示されるタイミングと、ユーザーがコンテンツとやり取りするタイミングを追跡して、分析と最適化を行います。
実際のコードベースのエクスペリエンスを確認するには、GitHub のサンプル実装を参照してください。
詳しくは、コードベースのエクスペリエンスの基本を学ぶを参照してください。
イベントストリーミングの実装 event-streaming
ジャーニーをトリガーするイベントの送信
開発者は、ジャーニーをトリガーするイベントを送信するコードを実装します。データエンジニアは、Journey Optimizer でイベントスキーマと定義を設定します。
-
イベントペイロードを理解:データエンジニアと連携して、イベントスキーマと必要なペイロード構造を取得します。ペイロードは、設定した XDM スキーマに準拠する必要があります。詳しくは、イベントスキーマ要件を参照してください。
-
イベントストリーミングを実装:Streaming Ingestion 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 エンドポイントを作成:ジャーニー実行中に Journey Optimizer により呼び出される RESTful API エンドポイントを作成します。エンドポイントで次の操作を実行する必要があります。
- JSON ペイロードを受け入れる
- リクエストを認証(OAuth、API キーまたは JWT)
- 適切なタイムアウト制限内でリクエストを処理
- 応答を想定される形式で返す
-
カスタムアクションの機能を理解:カスタムアクションは、Epsilon、Slack、Firebase などのサードパーティシステムや独自のサービスに接続できます。詳しくは、カスタムアクションを参照してください。
-
アクション設定を操作:管理者またはデータエンジニアは、Journey Optimizer でカスタムアクションを設定し、API エンドポイント URL、認証方法、パラメーターを定義します。お客様は、API 仕様を管理者またはデータエンジニアに提供してください。詳しくは、カスタムアクション設定を参照してください。
-
アクションにつながるデータを返す:後続のジャーニーステップで使用できるデータを返すように API をデザインします。詳しくは、アクション応答を参照してください。
-
レート制限を実装:エンドポイントが想定されるボリュームを処理できることを確認します。Journey Optimizer では、1 秒あたり 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)の場合は、高スループットモードを探索します(アドオンライセンスが必要)。
-
Decision Management API:オファー管理と決定に専用の API を使用します。詳しくは、Decision Management API ガイドを参照してください。
テストとデバッグ testing
-
SDK 実装をデバッグ:Adobe Experience Platform Assurance を使用して、SDK イベントの検査、データ収集の検証、統合に関する問題のトラブルシューティングをリアルタイムで行います。オーディエンスの詳細情報。
-
イベント配信をテスト:アプリケーションからのイベントが Adobe Experience Platform により正しく受信され、期待どおりにジャーニーがトリガーされることを確認します。イベントの取り込みを監視し、ペイロード構造を検証します。
-
API 統合を検証:カスタムアクションエンドポイントをテストして、Journey Optimizer リクエストが正しく処理され、タイムアウト制限内に応答し、期待されるデータ形式が返されることを確認します。
-
テストプロファイルでテストモードを使用:データエンジニアと連携してテストプロファイルにアクセスし、ジャーニーテストモードを使用して実装を検証します。詳しくは、ジャーニーのテスト方法を参照してください。
-
SDK ログを監視:SDK 実装でデバッグログを有効にして、開発中の問題をトラブルシューティングします。
- Mobile SDK:ログを有効にして、SDK イベントと API 呼び出しを確認します
- Web SDK:ブラウザーコンソールを使用して SDK アクティビティを監視します
-
データストリームの設定を確認:データストリームが Journey Optimizer にデータを送信するために正しく設定されていることを確認します。イベントがデータストリームを通じて正しい宛先にフローされることを確認します。
-
分析用にジャーニーデータのクエリを実行:データレイクで SQL クエリを使用して、ジャーニーステップイベントの分析、問題のデバッグ、カスタムアクションのパフォーマンスの監視を行います。次を含むジャーニー分析のクエリ例を探索します。
- プロファイルのエントリ/終了のトラッキングと破棄理由
- カスタムアクションのパフォーマンス指標(待ち時間、スループット、エラー)
- イベントの配信パターンとエラーパターン
- ジャーニーインスタンスの状態
高度な開発者向けトピック advanced-topics
コンテキストデータとエンリッチメントの操作
- 配列を反復処理:Handlebars 構文を使用して、イベント、カスタムアクション応答およびメッセージ内のデータセット検索からの動的なリストを表示します。詳しくは、コンテキストデータの反復処理を参照してください。
- データセット参照:データセット参照を実装して、Adobe Experience Platform データセットからのジャーニーデータを強化します。設定について詳しくは、データエンジニアと連携してください。詳しくは、データセット参照を参照してください。
同意とガバナンスの操作
統合にデータガバナンスと同意ポリシーを実装します。
最適化とベストプラクティス
- キャップとスロットル:レート制限を理解し、適切なスロットルを実装します。詳しくは、外部システムを参照してください。
- ジャーニーの最適化:ジャーニーの最適化のベストプラクティスに従います。
- エラー処理:堅牢なエラー処理を実装します。詳しくは、エラーコードおよびトラブルシューティングガイドを参照してください。
その他のリソース additional-resources
- Developer Console:Adobe Developer Console にアクセスして統合を作成し、API 資格情報を管理します。
- サンプルコード:GitHub のサンプル実装を探索します。
- チュートリアルビデオ:Experience League の実践的なチュートリアルを通じて学びます。
- 開発者コミュニティ:アドビコミュニティフォーラムで、他の開発者とつながり、サポートを受けることができます。
役割をまたいだ共同作業 next-steps
実装作業は、次の他のチームメンバーと連携します。
データとイベントの設定に関するデータエンジニアとの共同作業:
-
実装に必要な XDM スキーマとイベント構造を取得
-
送信する必要があるイベントとその必須のペイロード形式を理解
-
データ収集要件とデータ品質基準に関して調整
-
イベント配信とデータ取り込みを連携してテスト
アクセスと設定に関する管理者との共同作業:
-
設定するカスタムアクションの API 仕様を提供
-
必要な権限と API 資格情報をリクエスト
-
チャネル設定要件(例:プッシュ証明書)を調整
-
テスト環境とサンドボックス戦略を調整
ジャーニー要件とテストに関するマーケターとの共同作業:
-
イベントをトリガーする必要があるユーザーインタラクションを理解
-
コンテンツのパフォーマンスとユーザーエンゲージメントのトラッキングを実装
-
実装した機能を使用してジャーニーのテストをサポート
-
メッセージ配信やパーソナライゼーションに関する問題をトラブルシューティング
実装の開始
作成を開始する準備は整っていますか?上記の節から最初の実装領域を選択します。
- モバイルアプリですか?Mobile SDK 統合から開始します
- Web サイトですか?Web SDK 設定から開始します
- API 統合ですか?API の操作にジャンプします
- カスタムシステムですか?カスタムアクションを確認します
各節には、実装をガイドする詳細な技術ドキュメント、コードサンプル、チュートリアルへのリンクが含まれています。