このページ:実際のテスト API 呼び出しを送信し、カスタムアクション設定を検証します。これにより、ライブジャーニーでこれらに依存する前にエラーを検出できます。
Journey Optimizer ユーザーインターフェイスの管理セクションから API 呼び出しを送信して、カスタムアクションをテストできます。 この機能は、ジャーニーでカスタムアクションを使用する前または使用した後に、カスタムアクションのトラブルシューティングを行うのに役立ちます。
管理者は、テストリクエストを送信機能を使用し、Adobe Journey Optimizer から直接実際の API 呼び出しを行って、カスタムアクション設定を検証します。 この機能により、リクエスト構造、ヘッダー、認証およびペイロードがジャーニーで使用される前に正しく書式設定されていることが確保されます。
この機能を使用すると、テストと検証のプロセスが効率化され、カスタムアクションがライブジャーニーで正しく機能することが確保されます。
前提条件 troubleshoot-custom-action-prereq
テストリクエストを送信機能を使用するには、URL、ヘッダーおよび認証設定を使用して カスタムアクション を事前設定する必要があります。
管理者がこの機能を使用するには、次の権限が必要です。
- ユーザーには、Manage journeys events, data sources and actions 権限が必要です。
- この権限は、ジャーニー管理者の役割に含まれます。
- View journeys events の権限だけでは不十分です。
ジャーニーの権限について詳しくは、この節を参照してください。
テストリクエストを送信機能の使用方法 troubleshoot-custom-action-use
カスタムアクションをテストするには、次の手順に従います。
-
アクション設定画面に移動し、カスタムアクションを選択します。
-
アクション設定画面の下部にある「テストリクエストを送信」ボタンをクリックします。
{width="70%"}
-
ポップアップウィンドウで、リクエストパラメーターを指定できます。
-
カスタムアクションメソッドは GET ですの場合は、ペイロードは必要ありません。
-
カスタムアクションメソッドは POST の場合は、JSON ペイロードを指定する必要があります。
note NOTE この JSON の構造が正しくない場合は、Adobe Journey Optimizer でエラーが発生しますが、データタイプに不一致がある場合はエラーが発生しません。 例えば、文字列を指定する必要があるものに整数パラメーターを使用した場合、エラーは発生しません。 -
認証を定義した場合は、認証の詳細の入力を求めるプロンプトが表示されます。
-
-
「送信」をクリックして、リクエストを実行します。
-
ヘッダーやステータスコードを含む API からの応答がインターフェイスに表示されます。
認証処理 troubleshoot-custom-action-auth
カスタムアクションに認証が含まれる場合、Adobe Journey Optimizer では、テストリクエストごとにユーザーが認証の詳細を入力する必要があります。
- 基本認証:ユーザーは パスワード を入力する必要があります。
- API キー認証:ユーザーは API キー 値 を入力する必要があります。
- カスタム認証:ユーザーはリクエスト bodyParam に認証パラメーターを指定する必要があります。 この場合、認証リクエストと 認証応答 の 2 つのセクションが追加されます。
主なメリット troubleshoot-custom-action-benefits
Journey Optimizer 管理者は、外部ツール(Postman など)を使用して、カスタムアクションをテストすることもできます。 外部テストと比較した製品内トラブルシューティング機能の主なメリットを次に示します。
-
テストリクエストは、AJO ジャーニーによって実行されます。つまり、次のようになります。
- 正確なリクエスト構造(Adobe Journey Optimizer 固有のヘッダーを含む)が使用されます。
- ソース IP とヘッダーは、ライブジャーニーで使用されるものに一致します。
-
カスタムアクションが既にデプロイされているので、テストリクエストを送信機能は ライブジャーニー のトラブルシューティングに使用できます。
-
この製品内テスト機能により、ツール間で設定の詳細を手動でコピーする必要がなくなり、エラーのリスクが軽減されます。
トラブルシューティング troubleshoot-custom-action-check
リクエストが失敗した場合は、次の項目を確認できます。
- テストに入力された認証資格情報。
- リクエストメソッド(GET と POST)および対応するペイロード。
- カスタムアクションで定義される API エンドポイントとヘッダー。
- 応答データを使用した、潜在的な設定ミスの識別。
破棄イベントとアイドルタイムアウトの処理 handling-discard-events-and-idle-timeouts
1 つのジャーニーのカスタムアクションが、2 番目のジャーニーを開始する予定のイベントをトリガーする際、その 2 番目のジャーニーが有効な状態で、イベントが認識されることを確認します。 イベントが 2 番目のジャーニーのエントリ条件を満たさない場合、そのイベントは 破棄 され、notSuitableInitialEvent などのコードと共にログに表示されます。 2 番目のジャーニーの準備が整っていない場合、アイドルタイムアウトが発生し、ログに破棄イベントが記録される場合があります。
一般的な原因:
-
イベントの選定が満たされていない - 2 番目のジャーニーでは、選定条件(例:特定のフィールドに対する
isNotEmptyなど、必須フィールドは空でないフィールドにする必要があります)を含むルールベースのイベントを使用します。 イベントペイロードがその条件を満たさない場合(例:フィールドが空または欠落している)、イベントは 受信されますが破棄 され、2 番目のジャーニーはトリガーされません。 これは期待される動作です。ドキュメントとログでは、選定条件が満たされない場合、イベントは破棄され、そのプロファイルに対してジャーニーがトリガーされないことを確認します。 カスタムアクションによって送信されるペイロードに、2 番目のジャーニーのイベント設定で必須とされるすべてのフィールドと値が含まれていることを確認します。 詳しくは、ジャーニー実行時のルールベースのイベントの設定方法およびイベント受信のトラブルシューティング方法を参照してください。 -
2 番目のジャーニーの準備が整っていない - 2 番目のジャーニーがまだアクティブでない場合(例:テストモードやライブではない)や、カスタムアクションの実行と 2 番目のジャーニーの受信準備完了との間にタイミングのギャップがある場合、アイドルタイムアウトが発生することがあります。 カスタムアクションがトリガーされる前に、ターゲットジャーニーが公開済みであるか、テストモードであることを確認します。
-
破棄イベントの診断 - ログに破棄イベントが表示される場合は、ジャーニーログや Splunk トレースを確認し、イベントが受信されたが、選定(ペイロードがルールを満たさなかった)やタイミングにより破棄されたかどうかを確認します。 2 番目のジャーニーの開始日や設定が正しいことと、ジャーニーがアクティブな日付ウィンドウ内にあることを確認します。
カスタムアクション経由でジャーニーを連結する際に破棄イベントを回避するには、2 番目のジャーニーのイベントルールに対してイベントペイロードを検証し、ターゲットジャーニーがライブまたはテスト中で、アクティブな日付ウィンドウ内にあることを確認します。
その他のリソース
カスタムアクションの設定と使用について詳しくは、以下の節を参照してください。
- カスタムアクションの基本を学ぶ - カスタムアクションの概要と、サードパーティシステムへの接続に役立つ仕組みについて説明します。
- カスタムアクションの設定 - カスタムアクションの作成および設定方法について説明します
- カスタムアクションの使用 - ジャーニーでのカスタムアクションの使用方法について説明します
- コレクションをカスタムアクションパラメーターに渡す - 実行時に値が動的に入力されるコレクションをカスタムアクションパラメーターに渡す方法について説明します
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 explains how to use the Send test request capability to validate custom action configurations by making real API calls directly from Journey Optimizer, before or after using them in live journeys.
Intents:
- Send a real test API call to validate a custom action configuration
- Provide the correct payload depending on whether the method is GET or POST
- Enter authentication details required for each test request
- Understand the benefits of in-product testing compared to external tools
- Diagnose discard events and idle-timeouts when chaining journeys via custom actions
Glossary:
- Send test request: The capability administrators use to validate a custom action configuration by making real API calls directly from Adobe Journey Optimizer, checking request structure, headers, authentication, and payload (product-specific)
- Discard event: An event that is received but discarded, appearing in logs with codes such as notSuitableInitialEvent, when it does not meet the second journey’s entry conditions (product-specific)
- Idle timeout: A timeout that may occur if the second journey is not ready, leading to discard events in the logs (product-specific)
- IP (egress) proxy: A proxy that, when enabled for your organization, is bypassed by the Send test request call (product-specific)
Guardrails:
- To use the Send test request capability, a custom action must be pre-configured with a URL, headers, and authentication settings.
- Users must have the Manage journeys events, data sources and actions permission, which is included in the Journey Administrators role; the View journeys events permission alone is not sufficient.
- If the custom action method is GET, no payload is required; if the method is POST, you must provide a JSON payload.
- Adobe Journey Optimizer raises an error if the structure of the JSON is incorrect, but not if there is a mismatch with a data type; for instance, no error is raised if an integer parameter is used for what should be a string.
- If your organization has the IP (egress) proxy enabled, the Send test request call bypasses it; to confirm proxy routing, run a test or live journey.
- For chained journeys, the second journey must be published or in test mode before the custom action is triggered, and within its active date window.
Terminology:
- Canonical name: Send test request — Acronym: n/a — variants: test request, in-product troubleshooting capability
- Synonyms: “AJO Journey” = “the executor of the test request, using the exact request structure and Adobe Journey Optimizer specific headers”
- Do not confuse: “Basic Authentication” (user provides the password) ≠ “API Key Authentication” (user enters the API key value) ≠ “Custom Authentication” (user supplies parameters in the request bodyParam)
- Do not confuse: “GET” method (no payload required) ≠ “POST” method (JSON payload required)
FAQ:
- Q: What does the Send test request capability do? — It validates a custom action configuration by making real API calls directly from Adobe Journey Optimizer, ensuring the request structure, headers, authentication, and payload are correctly formatted before being used in a journey.
- Q: What permissions are required? — Users must have the Manage journeys events, data sources and actions permission, included in the Journey Administrators role; the View journeys events permission alone is not sufficient.
- Q: Do I need a payload for the test request? — If the custom action method is GET, no payload is required; if the method is POST, you must provide a JSON payload.
- Q: Does Journey Optimizer validate the payload data types? — It raises an error if the JSON structure is incorrect, but not if there is a data type mismatch, so an integer used where a string is expected does not raise an error.
- Q: Can I use this capability for live journeys? — Yes, the Send test request capability can be used for troubleshooting live journeys, as the custom action is already deployed.
- Q: Why is an event discarded when chaining journeys? — The event can be received but discarded, appearing in logs with codes such as notSuitableInitialEvent, when it does not meet the second journey’s qualification condition or the second journey is not ready.