Flow Service API を使用したデータフローのモニター
Adobe Experience Platform では、外部ソースからデータを取り込むと同時に、Platform サービスを使用して受信データの構造化、ラベル付け、および拡張を行うことができます。Adobeアプリケーション、クラウドベースのストレージ、データベースなど、様々なソースからデータを取り込むことができます。 さらに、Experience Platformを使用すると、外部パートナーに対してデータをアクティブ化できます。
Flow Service を使用すると、様々な異なるソースから顧客データを収集し、Adobe Experience Platformで一元化できます。 このサービスは、ユーザーインターフェイスと RESTful API を提供し、サポートされているすべてのソースと宛先を接続できます。
このチュートリアルでは、Flow Service API を使用して、完全性、エラーおよび指標のフロー実行データをモニタリングする手順を説明します。
はじめに
このチュートリアルでは、有効なデータフローの ID 値が必要です。有効なデータフロー ID がない場合は、このチュートリアルを試す前に、 ソースの概要または 宛先の概要からコネクタを選択して、説明した手順に従ってください。
このチュートリアルでは、Adobe Experience Platform の次のコンポーネントについて十分に理解していることを前提にしています。
- 宛先：宛先は、一般に使用されるアプリケーションとの事前定義済みの統合で、これを使用すると、Platform のデータをシームレスにアクティブ化してクロスチャネルマーケティングキャンペーン、メールキャンペーン、ターゲット広告およびその他の多くのユースケースを実現できます。
- ソース：Experience Platform を使用すると、データを様々なソースから取得しながら、Platform サービスを使用して受信データの構造化、ラベル付け、拡張を行うことができます。
- サンドボックス：Experience Platform には、単一の Platform インスタンスを別々の仮想環境に分割して、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。
次の節では、Flow Service API を使用してフロー実行を正常に監視するために必要な追加情報を示しています。
API 呼び出し例の読み取り
このチュートリアルでは、API 呼び出しの例を提供し、リクエストの形式を設定する方法を示します。これには、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、 トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してくださいExperience Platform。
必須ヘッダーの値の収集
Platform API を呼び出すには、まず認証チュートリアルを完了する必要があります。次に示すように、すべての Experience Platform API 呼び出しに必要な各ヘッダーの値は認証チュートリアルで説明されています。
Authorization: Bearer {ACCESS_TOKEN}x-api-key: {API_KEY}x-gw-ims-org-id: {ORG_ID}
Flow Serviceに属するリソースを含む、Experience Platform のすべてのリソースは、特定の仮想サンドボックスに分離されます。Platform API へのすべてのリクエストには、操作がおこなわれるサンドボックスの名前を指定するヘッダーが必要です。
x-sandbox-name: {SANDBOX_NAME}
ペイロード（POST、PUT、PATCH）を含むすべてのリクエストには、メディアのタイプを指定する以下のような追加ヘッダーが必要です。
Content-Type: application/json
フロー実行の監視
データフローを作成したら、Flow Service API に対してGETリクエストを実行します。
API 形式
GET /runs?property=flowId=={FLOW_ID}
{FLOW_ID}id 値。リクエスト
次のリクエストは、既存のデータフローの仕様を取得します。
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/runs?property=flowId==c9cef9cb-c934-4467-8ef9-cbc934546741' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
応答
正常な応答は、作成日、ソース接続、ターゲット接続に関する情報、フロー実行の一意の識別子（id）など、フロー実行に関する詳細を返します。
{
"items": [
{
"id": "65b7cfcc-6b2e-47c8-8194-13005b792752",
"createdAt": 1607520228894,
"updatedAt": 1607520276948,
"createdBy": "{CREATED_BY}",
"updatedBy": "{UPDATED_BY}",
"createdClient": "{CREATED_CLIENT}",
"updatedClient": "{UPDATED_CLIENT}",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "prod",
"imsOrgId": "{ORG_ID}",
"flowId": "f00c8762-df2f-432b-a7d7-38999fef5e8e",
"etag": "\"560266dc-0000-0200-0000-5fd0d0140000\"",
"metrics": {
"durationSummary": {
"startedAtUTC": 1607520205922,
"completedAtUTC": 1607520262413
},
"sizeSummary": {
"inputBytes": 87885,
"outputBytes": 56730
},
"recordSummary": {
"inputRecordCount": 26758,
"outputRecordCount": 26758,
"failedRecordCount": 0
},
"fileSummary": {
"inputFileCount": 11,
"outputFileCount": 11,
"activityRefs": [
"37b34f84-1ada-11eb-adc1-0242ac120002"
]
},
"statusSummary": {
"status": "success"
}
},
"activities": [
{
"id": "4f008a00-3a04-11eb-adc1-0242ac120002",
"name": "Copy Activity",
"updatedAtUTC": 0,
"durationSummary": {
"startedAtUTC": 1607520205922,
"completedAtUTC": 1607520236968
},
"sizeSummary": {
"inputBytes": 87885,
"outputBytes": 87885
},
"recordSummary": {
"inputRecordCount": 26758,
"outputRecordCount": 26758
},
"fileSummary": {
"inputFileCount": 11,
"outputFileCount": 11
},
"statusSummary": {
"status": "success"
}
},
{
"id": "37b34f84-1ada-11eb-adc1-0242ac120002",
"name": "Promotion Activity",
"updatedAtUTC": 0,
"durationSummary": {
"startedAtUTC": 1607520244985,
"completedAtUTC": 1607520262413
},
"sizeSummary": {
"inputBytes": 26758,
"outputBytes": 56730
},
"recordSummary": {
"inputRecordCount": 26758,
"outputRecordCount": 26758,
"failedRecordCount": 0
},
"fileSummary": {
"inputFileCount": 11,
"outputFileCount": 2,
"extensions": {
"manifest": {
"fileInfo": "https://platform.adobe.io/data/foundation/export/batches/01ES3TRN69E9W2DZ770XCGYAH1/meta?path=input_files",
"pathPrefix": "bucket1/csv_test/"
}
}
},
"statusSummary": {
"status": "success"
}
}
]
}
]
}
itemsmetricsactivitiesdurationSummarysizeSummaryrecordSummaryfileSummaryfileSummary.extensionsmanifest は「プロモーションアクティビティ」の一部にすぎないので、extensions オブジェクトに含まれます。statusSummary次の手順
このチュートリアルでは、Flow Service API を使用して、データフローの指標とエラー情報を取得しました。これで、取り込みスケジュールに応じて、データフローを引き続きモニターし、そのステータスと取り込み率をトラックできるようになります。ソースのデータフローを監視する方法について詳しくは、 ユーザーインターフェイスを使用したソースのデータフローの監視チュートリアルをお読みください。 宛先のデータフローを監視する方法について詳しくは、 ユーザーインターフェイスを使用した宛先のデータフローの監視チュートリアルをお読みください。