カスタムアクションの設定 configure-a-custom-action
サードパーティ製システムを使用してメッセージを送信する場合、またはジャーニーがサードパーティ製システムに API 呼び出しを送信する場合は、カスタムアクションを使用してジャーニーへの接続を設定します。 例えば、カスタムアクションを使用して Epsilon、Slack、Adobe Developer、Firebase などのシステムに接続できます。
カスタムアクションは、技術ユーザーが定義し、マーケターが使用できる追加のアクションです。 設定が完了すると、アクションカテゴリの、ジャーニーの左側のパレットに表示されます。 詳しくは、このページを参照してください。
設定の手順 configuration-steps
カスタムアクションを設定する際に必要な主な手順は次のとおりです。
-
管理メニューセクションで、「設定」を選択します。 「アクション」セクションで、「管理」をクリックします。 「アクションを作成」をクリックして、新規のアクションを作成します。 画面右側にアクション設定ペインが開きます。
-
アクションの名前を入力します。
note NOTE 英数字とアンダースコアのみが使用できます。 最大長は 30 文字です。 -
アクションに説明を追加します。 この手順はオプションです。
-
このアクションを使用しているジャーニーの数は、「使用されている場所」フィールドに表示されます。 「ジャーニーを表示」ボタンをクリックすると、このアクションを使用するジャーニーのリストを表示できます。
-
様々な URL 設定パラメーターを定義します。 このページを参照してください。
-
「認証」セクションを設定します。 この設定はデータソースの場合と同じです。 この節を参照してください。
-
アクションパラメーターを定義します。 このページを参照してください。
-
「保存」をクリックします。
カスタムアクションが設定され、ジャーニーで使用できる状態になります。 このページを参照してください。
note NOTE ジャーニーでカスタムアクションを使用する場合、ほとんどのパラメーターは読み取り専用です。 変更できるのは、名前、説明、URL フィールド、および 認証 セクションのみです。
制限事項 custom-actions-limitations
カスタムアクションには、このページに一覧表示されるいくつかの制限事項が伴います。
カスタムアクションパラメーターでは、単純なコレクションとオブジェクトのコレクションを渡すことができます。 コレクションの制限事項について詳しくは、このページを参照してください。
また、カスタムアクションパラメーターには想定される形式（例：文字列、10 進数など）があります。 これらの想定される形式に従うように注意する必要があります。 詳しくは、このユースケースを参照してください。
カスタムアクションは、リクエストまたは応答ペイロードを使用する際にのみ JSON 形式をサポートします。
ベストプラクティス custom-action-enhancements-best-practices
ターゲットにするエンドポイントをカスタムアクションを使用して選択する場合は、次の点を確認します。
- このエンドポイントは、Throttling API または Capping API の設定を使用してジャーニーのスループットをキャップすることでサポートできます。 スロットル設定は、200 TPS を下回ることはできません。 ターゲットにするエンドポイントは、200 TPS 以上をサポートする必要があります。 ジャーニーの処理率について詳しくは、この節を参照してください。
- このエンドポイントの応答時間は、できるだけ短くする必要があります。 予想されるスループットに応じて、応答時間が長いと、実際のスループットに影響を与える可能性があります。
すべてのカスタムアクションには、1 分間に 300,000 件の呼び出しというキャップが定義されています。 また、デフォルトのキャップは、ホストごとおよびサンドボックスごとに実行されます。 例えば、サンドボックスで、同じホストに 2 つのエンドポイントがある場合（例：https://www.adobe.com/endpoint1 と https://www.adobe.com/endpoint2）、キャップは adobe.com ホストの下にあるすべてのエンドポイントに適用されます。 「endpoint1」と「endpoint2」は同じキャップ設定を共有し、一方のエンドポイントがキャップに達すると、もう一方のエンドポイントに影響が生じます。
デフォルトの 1 分あたり 300,000 回の呼び出し制限は、ドメインレベル（例：example.com）で適用されます。 より高い制限が必要な場合は、使用状況の証拠を添えてアドビサポートに連絡し、エンドポイントのスループットを確認します。 キャップの増加をリクエストするには、予想される呼び出し量とエンドポイントの処理能力の詳細を提供します。 処理能力テストにより、エンドポイントがより高いスループットを処理できることが示された場合、アドビではキャップをカスタマイズすることがあります。 ベストプラクティスとしては、アウトバウンド呼び出しを調整し、キャップエラーを回避するために、ジャーニーを再構築するか、待機アクティビティを実装することを考慮します。
この制限は、カスタムアクションによって対象となる外部エンドポイントを保護することを目的に、顧客の使用状況に基づいて設定されます。 必要に応じて、Capping API と Throttling API でキャップまたはスロットルキャップを大きく定義することで、この設定を上書きできます。 このページを参照してください。
次に示すような様々な理由により、カスタムアクションを使用してパブリックエンドポイントをターゲット設定しないでください。
- 適切なキャップやスロットルがない場合、パブリックエンドポイントに対して過剰な呼び出しが送信される恐れがあり、その量に対応できない可能性があります。
- プロファイルデータは、カスタムアクションを通じて送信できるため、パブリックエンドポイントをターゲティングすると、誤って個人情報を外部と共有してしまう可能性があります。
- パブリックエンドポイントから返されるデータを制御できません。 エンドポイントの API を変更した場合や誤った情報の送信を開始した場合は、送信された通信でそれらの情報が使用可能になり、悪影響が出る可能性があります。
同意とデータガバナンス privacy
Journey Optimizer では、カスタムアクションにデータガバナンスポリシーと同意ポリシーを適用して、特定のフィールドがサードパーティシステムにエクスポートされないようにしたり、メール、プッシュまたは SMS 通信の受信に同意しない顧客を除外したりできます。 詳しくは、次のページを参照してください。
エンドポイントの設定 url-configuration
カスタムアクションを設定する際に、次の エンドポイント設定 パラメーターを定義する必要があります。
-
「URL」フィールドに、外部サービスの URL を指定します。
-
URL が静的な場合は、このフィールドに URL を入力します。
-
URL に動的パスが含まれる場合は、URL の静的な部分（スキーム、ホスト、ポート、オプションでパスの静的な部分）のみを入力します。
例：
https://xxx.yyy.com/somethingstatic/URL の動的パスは、カスタムアクションをジャーニーに追加する際に指定します。 詳細情報。
note NOTE セキュリティ上の理由から、URL には HTTPS スキームを使用することを強くお勧めします。 また、アドビの非公開アドレスや IP アドレスの使用は許可されていません。 カスタムアクションを定義する場合は、デフォルトのポートのみ使用できます。http の場合は 80、https の場合は 443 です。 -
-
呼び出し メソッド を選択します。POST、GET または PUT を選択できます。
note NOTE DELETE メソッドはサポートされていません。 既存のリソースを更新する必要がある場合は、PUT メソッドを選択します。 -
潜在的なリダイレクト（302 応答）を処理します。 カスタムアクションは、リクエストごとに HTTP 302 リダイレクトに自動的に従います。
-
ヘッダーとクエリパラメーターを定義：
- 「ヘッダー」セクションで「ヘッダーフィールドを追加」をクリックし、外部サービスに送信されるリクエストメッセージの HTTP ヘッダーを定義します。 Content-Type および Charset ヘッダーフィールドは、デフォルトで設定されます。 これらのフィールドは削除できません。 Content-Type ヘッダーのみを変更できます。 この値は JSON 形式に従う必要があります。 デフォルト値は次のとおりです。
- 「クエリパラメーター」セクションで「クエリパラメーターフィールドを追加」をクリックして、URL に追加するパラメーターを定義します。
-
フィールドのラベルまたは名前を入力します。
-
タイプを選択：定数または変数。 定数を選択した場合は、値フィールドに定数の値を入力します。 「変数」を選択した場合は、カスタムアクションをジャーニーに追加する際に、この変数を指定します。 詳細情報。
note NOTE カスタムアクションをジャーニーに追加した後でも、ジャーニーがドラフトステータスの場合は、ヘッダーフィールドまたはクエリパラメータフィールドを追加できます。 設定変更によってジャーニーに影響を与えたくない場合は、カスタムアクションを複製し、フィールドを新しいカスタムアクションに追加します。 ヘッダーは、フィールド解析ルールに従って検証されます。 詳しくは、このドキュメントを参照してください。
輸送セキュリティ層 tls
TLS プロトコルのサポート tls-protocol-support
Adobe Journey Optimizer は、カスタムアクションに対してデフォルトで TLS 1.3 をサポートしています。 クライアントがTLS 1.3もサポートしている場合、通信はTLS 1.3を介して行われます。 それ以外の場合、TLS ネゴシエーション プロセスはTLS 1.2にフォールバックする可能性があります。
mTLS プロトコルのサポート mtls-protocol-support
Mutual Transport Layer Security（mTLS）は、Adobe Journey Optimizer カスタムアクションへの送信接続のセキュリティを強化します。 mTLS は、データが共有される前に情報を共有する両者が本人であることを確認する、相互認証のためのエンドツーエンドのセキュリティ方式です。 mTLS には TLS と比較して追加の手順が含まれており、サーバーはクライアントの証明書を要求し、クライアント側でそれを検証します。
カスタムアクションでは相互 TLS（mTLS）認証がサポートされています。 mTLS をアクティブ化するためにカスタムアクションまたはジャーニーで追加の設定は必要ありません。mTLS 対応エンドポイントが検出されると、自動的に実行されます。 詳細情報
ペイロードパラメーターの定義 define-the-message-parameters
以下で説明するように、ペイロードパラメーターを定義できます。
-
「リクエスト」セクションに、外部サービスに送信する JSON ペイロードの例をペーストします。 このフィールドはオプションで、POST および PUT 呼び出しメソッドでのみ使用できます。
「NULL 値を許可」オプションを有効にして、外部呼び出しで Null 値を保持します。 内のNull値を持つintやstringなどの配列の送信は完全にはサポートされていないことに注意してください。 例えば、次の整数の配列
[1, null, 2, 3]は、このオプションがオンになっていても[1, 2, 3]として送信されます。 さらに、そのような配列が null の場合は、空の配列として送信されます。
-
応答 セクションに、呼び出しが成功したときに返されたペイロードの例を貼り付けます。 このフィールドはオプションで、すべての呼び出しメソッドで使用できます。 カスタムアクションで API 呼び出し応答を活用する方法について詳しくは、このページを参照してください。
-
（オプション）「エラー応答ペイロードを定義」を選択して、エラー応答ペイロードフィールドを有効にします。 有効にすると、エラー応答 セクションを使用して、呼び出しが失敗したときに返されたペイロードの例を貼り付けます。 応答ペイロード（フィールドタイプと形式）と同じ要件が適用されます。 ジャーニーここでエラー応答ペイロードを活用する方法について説明します。
. 文字を含んだり、$ 文字で始まったりすることはできません。
これらのフィールド設定では、次の操作を行う必要があります。
-
パラメーターのタイプ（例：文字列、整数など）を選択
-
定数または変数パラメーターを定義
-
定数は、パラメーターの値が、技術担当者によって「アクション設定」ペインで定義されることを意味します。 この値は、ジャーニーをまたいで常に同じになります。 ジャーニーでカスタムアクションを使用する場合、この値は変わらず、マーケターは確認できません。 例えば、サードパーティのシステムが予期する ID を指定できます。 この場合、「定数／変数」切替スイッチの右側にあるフィールドに定数値が設定されます。
-
変数は、パラメーターの値が変化する可能性があることを意味します。 ジャーニーでこのカスタムアクションを使用するマーケターは、必要な値を渡したり、このパラメーターの値をどこから取得するか（例：イベント、Adobe Experience Platform など）を指定したりすることが自由にできます。 この場合、定数／変数切替スイッチの右側にあるフィールドは、マーケターがこのパラメーターに名前を付ける際にジャーニーで表示されるラベルです。
オプションのパラメーターについては、行の最後にある「はオプションです」オプションを有効にします。 このオプションをオンにすると、パラメーターが非必須としてマークされ、ジャーニー担当者はジャーニーでそのカスタムアクションをオーサリングする際に、そのパラメーターを入力するかどうかを選択できます。
-
その他のリソース
カスタムアクションの設定、使用、トラブルシューティングについて詳しくは、以下の節を参照してください。
- カスタムアクションの基本を学ぶ - カスタムアクションの概要と、サードパーティシステムへの接続に役立つ仕組みについて説明します。
- カスタムアクションの使用 - ジャーニーでのカスタムアクションの使用方法について説明します
- カスタムアクションのトラブルシューティング - カスタムアクションのトラブルシューティング方法について説明します
- コレクションをカスタムアクションパラメーターに渡す - 実行時に値が動的に入力されるコレクションをカスタムアクションパラメーターに渡す方法について説明します