Show Menu
トピック×

外部 API

説明

アクティビティ External API は、 REST API呼び出しを介して外部システム からワークフ ローにデータを取り込みます
RESTエンドポイントは、顧客管理システム、 Adobe I/O Runtime Instance、またはExperience Cloud RESTエンドポイント(Data Platform、Target、Analytics、Campaignなど)です。
セキュリティ上の理由から、JSSPの使用はCampaign Standardではサポートされていません。 コードを実行する必要がある場合は、External APIアクティビティを介してAdobe I/O Runtimeインスタンスを呼び出すことができます。
この機能は現在ベータ版です。 External APIアクティビティの使用を開始する前に、使用許諾契約に同意する必要があります。 このベータ版機能はアドビがまだ市販していないので、Adobe ClientCareではサポートされていないので、エラーが含まれ、他のリリースされた機能と同様に機能しない場合があります。
このアクティビティの主な特徴は次のとおりです。
  • JSON形式のデータをサードパーティのREST APIエンドポイントに渡す機能
  • JSON応答を受け取り、出力テーブルにマッピングして、他のワークフローアクティビティに下流に渡す機能。
  • アウトバウンド固有の移行による失敗管理
このアクティビティに対して、次のガードレールが配置されました。
  • 50MB HTTP応答のデータサイズの制限
  • 要求のタイムアウトは10分です
  • HTTPリダイレクトは許可されません
  • HTTPS以外のURLは拒否されます
  • 「受け入れ:application/json"リクエストヘッダーと"Content-Type:application/json"応答ヘッダーを使用できます
アクティビティは、キャンペーン全体のデータ(最新のオファーのセット、最新のスコアなど)を取得する目的で作成されます。各プロファイルの特定の情報を取得する場合は除きます。これにより、大量のデータが転送される可能性があります。 使用事例で必要な場合は、「ファイルを転送」アクティビティを使 用すること が推奨されます。

設定

アクティビティをワークフ External API ローにドラッグ&ドロップし、アクティビティを開いて設定を開始します。

受信マッピング

インバウンドマッピングは、以前のインバウンドアクティビティによって生成された一時テーブルで、UIにJSONとして表示および送信されます。 この一時テーブルに基づいて、ユーザーは受信データを変更できます。
#ドロップダウンでは、一時テーブルを作成するクエリアクティビティを選択できます。
「カウ ントパラメータを追加 」チェックボックスをオンにすると、一時テーブルからの各行のカウント値が表示されます。 このチェックボックスは、受信アクティビティで一時テーブルが生成されている場合にのみ使用できます。
「受信 列」セクションで 、ユーザーは受信移行テーブルから任意のフィールドを追加できます。 選択した列は、データオブジェクトのキーになります。 JSON内のデータオブジェクトは、受信遷移テーブルの各行から選択した列のデータを含む配列リストになります。
customize parameter 」テキストボックスを使用すると、外部APIで必要なデータを含む有効なJSONを追加できます。 この追加データは、生成されたJSON内のparamsオブジェクトに追加されます。

送信マッピング

このタブでは、API呼び出しによって返さ れるサンプル JSON構造を定義できます。
JSON構造のパターンは次のとおりです。 {“data”:[{“key”:“value”}, {“key”:“value”},...]}
サンプルJSON定義には、次の特性が必要 です
  • dataは JSON内の必須のプロパティ名で、「data」の内容はJSON配列です。
  • 配列要素には 、第1レベルのプロパティが含まれている必要があります(より深いレベルはサポートされていません)。 プロパティ名は 、出力一時テーブルの出力スキーマの列名になります。
  • 列名の定義は 、「データ」配列の最初の要素に基づいています。 列の定義(追加/削除)とプロパティのタイプ値は、「列の定義」タブで編 集できます
解析が検証さ れると 、メッセージが表示され、「列の定義」タブでデータマッピングをカスタマイズするように招待されます。 その他の場合は、エラーメッセージが表示されます。

実行

このタブでは、ACSにデータを送信する HTTPSエンドポイント (HTTPS Endpoint)を定義できます。 必要に応じて、次のフィールドに認証情報を入力できます。

プロパティ

このタブを使用すると、UIに表 示されるラベルなど 、外部APIアクティビティの一般的なプロパティを制御できます。 内部IDはカスタマイズできません。

列の定義

このタブは、応答データの形式が 完了し 、「送信マッピング」タブで検証されたときに表示されます。
「列の定 」タブでは、各列のデータ構造を正確に指定して、エラーを含まないデータをインポートし、今後の操作のためにAdobe Campaignデータベースに既に存在するタイプと一致させることができます。
例えば、列のラベルを変更し、そのタイプ(文字列、整数、日付など)を選択できます。 またはエラー処理を指定することもできます。
For more information, refer to the Load File section.

トランジション

このタブでは、アウトバウンドトランジションと そのラベルを 、アクティブ化できます。 この特定の移行は、タイムアウトの場合や、ペ イロードが データサイズの制限を超えた場合に 役立ちます

実行オプション

このタブは、ほとんどのワークフローアクティビティで使用できます。 詳しくは、「アクティビティのプロパティ」 の節を参照してくださ い。

トラブルシューティング

この新しいワークフローアクティビティに追加されるログメッセージには、次の2種類があります。情報とエラー。 潜在的な問題のトラブルシューティングに役立ちます。

情報

これらのログメッセージは、ワークフローアクティビティの実行中に役立つチェックポイントに関する情報を記録するために使用されます。 具体的には、次のログメッセージを使用して、APIへのアクセスの再試行(および最初の試行に失敗した理由)と共に、最初の試行をログに記録します。
メッセージのフォーマット 例 :
API URL '%s'を呼び出しています。
API URLを呼び出しています: https://example.com/api/v1/web-coupon?count=2'
API URL '%s'を再試行していますが、前回の試行に失敗しました('%s')。
API URL 'https://example.com/api/v1/web-coupon?count=2''を再試行していますが、以前の試行は失敗しました('HTTP - 401')。
'%s'からコンテンツを転送中(%s / %s)。
'https://example.com/api/v1/web-coupon?count=2' (1234 / 1234)からコンテンツを転送しています。

エラー数

これらのログメッセージは、予期しないエラー状態に関する情報を記録するために使用されます。これにより、最終的にワークフローのアクティビティが失敗する可能性があります。
コード — メッセージの形式 例 :
WKF-560250 - API要求本文が制限を超えました(制限:'%d')。
APIリクエスト本文が制限を超えました(制限:'5242880')。
WKF-560239 - API応答が制限を超えました(制限:'%d')。
API応答が制限を超えました(制限:5242880')。
WKF-560245 - API URLを解析できませんでした(エラー:'%d')。
API URLを解析できませんでした(エラー:'-2010')。
注意:このエラーは、API URLが検証ルールに失敗した場合に記録されます。
WKF-560244 - APIのURLホストは'localhost'またはIPアドレスリテラル(URLホスト:'%s')。
API URLホストは'localhost'またはIPアドレスリテラル(URLホスト:'localhost')。
API URLホストは'localhost'またはIPアドレスリテラル(URLホスト:'192.168.0.5')。
API URLホストは'localhost'またはIPアドレスリテラル(URLホスト:'[2001]')。
WKF-560238:API URLは安全なURL (https)である必要があります(要求されたURL:'%s')。
API URLは、セキュリティで保護されたURL(https)である必要があります(要求されたURL:'https://example.com/api/v1/web-coupon?count=2')。
WKF-560249 — 要求本文JSONを作成できませんでした。 '%s'の追加中にエラーが発生しました。
要求本文JSONを作成できませんでした。 'params'の追加中にエラーが発生しました。
要求本文JSONを作成できませんでした。 「データ」の追加中にエラーが発生しました。
WKF-560246 - HTTPヘッダーキーが正しくありません(ヘッダーキー:'%s')。
HTTPヘッダーキーが正しくありません(ヘッダーキー:'%s')。
WKF-560248 - HTTPヘッダーキーは使用できません(ヘッダーキー:'%s')。
HTTPヘッダーキーは使用できません(ヘッダーキー:'受け入れ')。
WKF-560247 - AHTTPヘッダー値が正しくありません(ヘッダー値:'%s')。
HTTPヘッダー値が正しくありません(ヘッダー値:'%s')。
WKF-560240 - JSONペイロードのプロパティ'%s'が正しくありません。
JSONペイロードに不正なプロパティ'blah'があります。
WKF-560241 — 形式が正しくないか、受け入れられない形式です。
形式が正しくないか、受け入れられない形式です。
注意:このメッセージは、外部APIからの応答本文の解析にのみ適用され、応答本文がこのアクティビティで必須のJSON形式に準拠しているかどうかを検証しようとすると記録されます。
WKF-560246 — 操作に失敗しました(理由:'%s')。
HTTP 401エラー応答が原因でアクティビティが失敗した場合 — アクティビティが失敗しました(理由:'HTTP - 401')
内部呼び出しの失敗によりアクティビティが失敗した場合 — アクティビティが失敗しました(理由:'iRc - -Nn')。
Content-Typeヘッダーが無効でアクティビティが失敗した場合。 — アクティビティが失敗しました(理由:「Content-Type - application/html」)。