外部アクションの設定

外部対応により、Journey Optimizer B2B editionのアカウントジャーニーは、ジャーニーキャンバスから直接、外部システムと接続できます。 アカウントオーディエンスが外部アクションノードに到達すると、システムは設定された外部サービスに対して非同期発信コールを行い、アカウント、人物、またはその両方のオーディエンス属性データを渡します。 外部サービスは、データを処理し、コールバックを使用して応答し、ジャーニーの実行を導くために使用できるオーディエンスデータとメタデータを返します。

この機能では、次の2つのジャーニーノードタイプをサポートしています。

  • 外部アクション – 外部サービスを呼び出し、1つの送信パスに沿って続行します。 CRM レコードの更新や下流の通知のトリガーなど、火災と忘れ​の統合に最適です。
  • 外部分割パス – 外部サービスを呼び出し、定義された複数のパスのいずれかに沿ってアカウントをルーティングするために応答を評価します。
NOTE
外部アクションサービスは、アカウントジャーニーでのみサポートされます。 これらのノードタイプは、個人ジャーニーでは使用できません。

導入の概要

外部活動を設定するには、3つの役割をまたいで順番に調整する必要があります。

外部サービスの実装 implement-service

開発者は、Adobe Journey Optimizer B2B editionの外部アクションサービスプロバイダーインターフェイス ​に準拠した公開Web サービスを作成して公開する必要があります。

NOTE
コールバック関数にはベアラートークンが必要です。 これを取得するには、IMS組織用にAdobe Developer Console🔗でOAuth サーバー間の資格情報を設定します。

サービスが公開されたら、OpenAPI仕様のURLと認証情報を、アクションの設定を担当する製品管理者に提供します。

アクションの設定 configure-action

アクションは、マーケターがジャーニーで使用できるようにするために、設定し、アクティベートする必要があります。 アクションは​ ドラフト ​状態で作成され、変更は自動的に保存されます。 アクティベートするまでドラフトとして残ります。

PREREQUISITES
設定を追加する前に、開発者からOpenAPI仕様のURLと認証情報を取得します。
外部アクションを定義してアクティブ化するには、B2B管理設定の管理 製品権限が必要です。
  1. 管理 > 設定​に移動します。

  2. 中間パネルで「外部アクション」をクリックします。

    外部アクション設定スペースにアクセス ​ {width="800" modal="regular"}

  3. 右上の「アクションを作成」をクリックします。

  4. 外部サービスのOpenAPI仕様のURLを入力し、作成​をクリックします。

    ​ サービス URLを入力 {width="500"}

    このステップを成功させるには、外部サービスがライブで到達可能である必要があります。 検証エラーがある場合、ダイアログには、エラーを説明するメッセージと、そのエラーを解決するための提案が表示されます。 詳しくは、トラブルシューティング​を参照してください。

  5. URLが正常に解決したら、サービスの詳細​を確認します。

    サービスの詳細は、アクションの作成時にOpenAPI仕様から直接読み取られます。 作成後に設定でこれらのプロパティを変更することはできません。

    table 0-row-3 1-row-3 2-row-3 3-row-3
    プロパティ 説明 OpenAPI仕様プロパティ
    名前 アクションの名前 info.title
    説明 アクションの説明 info.description
    URL 外部サービスを定義するOpenAPI仕様へのURL servers.url
  6. 外部サービス (components.securitySchemes)の​ 認証 ​資格情報を入力します。

    note
    NOTE
    表示される資格情報フィールドは、外部サービスで定義された認証メカニズムによって異なります。 サポートされているタイプは、API キー、OAuth2、およびHTTP Basic認証です。

    認証資格情報を追加 {width="600" modal="regular"}

    設定されたアクションが​ ドラフト ​または​ アクティブ ​の状態にある場合、必要に応じて資格情報を変更できます。

  7. 次へ」をクリックします。

  8. アクションが外部サービスとデータを交換する方法を定義するには、設定 プロパティを設定します。

    note
    NOTE
    静的​としてマークされたプロパティは、設定時に更新できず、サービス定義に基づいています。
    • アクションの種類静的) – サポートされているジャーニーノードの種類:

      • 外部アクション ​ (enableSplitPath = false)
      • 外部アクション分割パス ​ (enableSplitPath = true)

      アクション設定の作成後にアクションタイプを変更することはできません。

    • アクセサー静的) – (外部アクション分割パスのみ)外部サービスによって返される変数は、外部スプリットパスノードのパス条件として使用できます。 (invocationPayloadDef.accessorsMetadata)

    • ジャーニーコンテキスト静的) – リクエストで送信されたオーディエンスデータの範囲(supportedEntityType):

      • ​ アカウント ​ - アカウントのみを送信

      • 人物 – 人物のみを送信

      • ​ アカウントのユーザー - アカウントおよびアカウント関連のユーザーを送信します

    • 送信フィールド - テーブル内の各フィールドをXDM フィールド ​にマッピングします。 これらのフィールドは、リクエスト本文で外部サービスに送信されます。 サービス定義プロパティ:invocationPayloadDef.accountFieldsinvocationPayloadDef.fields

      外部アクション送信フィールドのマッピング ​ {width="600" modal="regular"}

    • 受信フィールド - テーブル内の各フィールドを更新可能なXDM フィールド ​にマッピングします。 これらのフィールドは、外部サービス応答から入力されます。 サービス定義プロパティ:callbackPayloadDef.accountFieldscallbackPayloadDef.fields。 作成後に更新可能。

    • ヘッダーパラメーター - リクエストでHTTP ヘッダーとして渡す各行の値を入力します。 サービス定義プロパティ:invocationPayloadDef.headers

    • タイムアウト - リクエストが失敗したと見なされるまでのコールバックを外部サービスが呼び出すのを待つ時間を分単位で入力します。 サービス定義プロパティ:timeout

    • グローバル属性 - リクエスト本文に静的フィールドとして含める各行の値を入力します。 サービス定義プロパティ:invocationPayloadDef.globalAttributes

      外部アクション ヘッダーのパラメーター、タイムアウト、およびグローバル属性 {width="600" modal="regular"}

  9. 戻る矢印​をクリックしてリストに戻り、アクションを​ ドラフト ​状態に保ちます。

    または、アクティブ化​をクリックして、アクション設定を​ アクティブ ​状態に変更します。 設定された外部アクションは、アカウントジャーニーで使用できるようにするためにアクティブである必要があります。

トラブルシューティング troubleshooting

外部サービスのOpenAPI仕様にURLを入力し、Create​をクリックすると、システムはサービスの検証を実行します。 エラーが発生すると、ダイアログにエラーを説明するメッセージが表示されます。

外部アクション URL サービス検証エラーメッセージ ​ {width="600" modal="regular"}

NOTE
次の多くのエラーを解決するには、公開Web サービスを作成および公開した開発者と協力する必要があります。

検証エラーの詳細

表示されるエラー
なぜそうなったのか
今後の施策
This URL is already used by another external action
この仕様URLは、既に組織内の別のアクションに登録されています。
別の仕様URLを使用するか、既に使用している既存のアクションを削除します。
An action with this name already exists
スペックのinfo.titleは、既に存在するアクションと一致します
スペックのinfo.title フィールドのタイトルをユニークなものに変更します。
Duplicate operation ID found in the specification
スペック内の2つ以上の操作が同じoperationIdを共有しています。
すべての操作に一意のoperationIdを付与します。
Field in the specification exceeds the maximum allowed length
スペックのテキストフィールド(タイトルや説明など)が長すぎます。
フラグが設定されているフィールドを短くします。
The entity type value is invalid
エンティティ型のAdobe固有のx-拡張機能に認識されない値があります
エンティティの種類をサポートされている値に修正します。 有効なオプションについては、開発者ドキュメント ​を参照してください。
The provided document is not a valid OpenAPI specification
仕様は構造的に解析できません。
OpenAPI 3.0 スキーマに対して仕様を検証し、問題を修正します。
Required OpenAPI field is missing
標準のOpenAPI必須フィールドがありません(infoまたはpathsなど)。
見つからないフィールドを追加します。
Required endpoint is missing from the specification
Adobe Journey Optimizer B2B editionに必要なエンドポイントが、仕様で定義されていません。
必要なエンドポイントを追加します。 エンドポイントが必要な場合は、開発者ドキュメント ​を参照してください。
Required extension field is missing
必要なAdobe x-拡張機能フィールドがスペックにありません。
ドキュメントの説明に従って、不足している拡張機能フィールドを追加します。
Security schemes are missing from the specification
仕様にはcomponentsで定義されたsecuritySchemesがありません。
少なくとも1つのセキュリティスキームを定義します。
Multiple authentication types are not supported
仕様で複数の認証スキームが定義されています。
1つの認証タイプを使用するようにスペックを更新します。
The authentication type is not supported
使用したセキュリティスキームの種類(oauth2openIdConnectなど)はサポートされていません。
サポートされている認証タイプに切り替えます。 サポートされているオプションについては、開発者ドキュメントを参照してください。
The OpenAPI version is not supported
仕様レベルでのバージョンの不一致
OpenAPI 3.0.xを使用するように仕様を更新します。
An unexpected error occurred
仕様に未分類の問題が見つかりました。
スペックに異常がないか確認し、再度試してください。 エラーが解決しない場合は、サポートにお問い合わせください。

ジャーニーへの外部ノードの追加 add-journey-node

アクションがアクティブ化されると、マーケターは​ 外部アクション ​または​外部分割パス ノードを任意のアカウントジャーニーに追加できます。 アカウントジャーニーキャンバスでこれらのノードを追加および使用する方法について詳しくは、外部ノード ​を参照してください。

recommendation-more-help
journey-optimizer-b2b-help-user