フロー実行は、フロー実行のインスタンスを表します。 例えば、時間別のフローの午前 9:00、午前 10:00、午前 11:00 に実行するようにスケジュールされている場合、フロー実行の 3 つのインスタンスが存在します。 フロー実行は、特定の組織に固有です。
オンデマンド取り込みでは、特定のデータフローに対するフロー実行を作成できます。 これにより、ユーザーは、サービストークンを使用せずに、指定されたパラメーターに基づいてフロー実行を作成し、取り込みサイクルを作成できます。 オンデマンド取り込みのサポートは、バッチソースに対してのみ使用できます。
このチュートリアルでは、オンデマンド取り込みを使用し、 Flow Service API.
フロー実行を作成するには、まず、1 回の取り込み用にスケジュールされたデータフローのフロー ID が必要です。
このチュートリアルは、Adobe Experience Platform の次のコンポーネントを実際に利用および理解しているユーザーを対象としています。
Platform API を正常に呼び出す方法について詳しくは、Platform API の概要のガイドを参照してください。
テーブルベースのソースのフローを作成するには、 Flow Service 実行を作成するフローの ID と、開始時間、終了時間、デルタ列の値を提供する際の API。
テーブルベースのソースには、広告、分析、同意および環境設定、CRM、顧客の成功、データベース、マーケティングの自動化、支払い、プロトコルの各ソースカテゴリが含まれます。
API 形式
POST /runs/
リクエスト
次のリクエストは、フロー ID のフロー実行を作成します 3abea21c-7e36-4be1-bec1-d3bad0e3e0de
.
必要なのは、 deltaColumn
最初のフロー実行を作成する際に使用します。 その後 deltaColumn
の一部としてパッチを適用します copy
流れの中の変換であり、真理の源として扱われます。 変更を試みた場合 deltaColumn
フロー実行パラメーターを通じた値は、エラーを引き起こします。
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/runs' \
-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}' \
-H 'Content-Type: application/json'
-d '{
"flowId": "3abea21c-7e36-4be1-bec1-d3bad0e3e0de",
"params": {
"startTime": "1663735590",
"windowStartTime": "1651584991",
"windowEndTime": "16515859567",
"deltaColumn": {
"name": "DOB"
}
}
}'
パラメーター | 説明 |
---|---|
flowId |
フロー実行が作成されるフローの ID。 |
params.startTime |
オンデマンドフローの実行が開始される予定時間。 この値は UNIX 時間で表されます。 |
params.windowStartTime |
データの取得元となる最も早い日時。 この値は UNIX 時間で表されます。 |
params.windowEndTime |
データが取得されるまでの日時。 この値は UNIX 時間で表されます。 |
params.deltaColumn |
デルタ列は、データをパーティション化し、新しく取り込んだデータを履歴データから分離するために必要です。 注意: deltaColumn は、最初のフロー実行を作成する場合にのみ必要です。 |
params.deltaColumn.name |
デルタ列の名前。 |
応答
正常な応答は、新しく作成されたフロー実行の詳細(一意の実行を含む)を返します id
.
{
"items": [
{
"id": "3fb0418e-1804-45d6-8d56-dd51f05c0baf",
"etag": "\"1100c53e-0000-0200-0000-627138980000\""
}
]
}
プロパティ | 説明 |
---|---|
id |
新しく作成されたフロー実行の ID。 次のガイドを参照してください: フロー仕様の検索 を参照してください。 |
etag |
フロー実行のリソースのバージョン。 |
ファイルベースのソースのフローを作成するには、 Flow Service 実行を作成するフローの ID を指定する際の API と、開始時間および終了時間の値。
ファイルベースのソースには、すべてのクラウドストレージソースが含まれます。
API 形式
POST /runs/
リクエスト
次のリクエストは、フロー ID のフロー実行を作成します 3abea21c-7e36-4be1-bec1-d3bad0e3e0de
.
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/runs' \
-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}' \
-H 'Content-Type: application/json'
-d '{
"flowId": "3abea21c-7e36-4be1-bec1-d3bad0e3e0de",
"params": {
"startTime": "1663735590",
"windowStartTime": "1651584991",
"windowEndTime": "16515859567"
}
}'
パラメーター | 説明 |
---|---|
flowId |
フロー実行が作成されるフローの ID。 |
params.startTime |
オンデマンドフローの実行が開始される予定時間。 この値は UNIX 時間で表されます。 |
params.windowStartTime |
データの取得元となる最も早い日時。 この値は UNIX 時間で表されます。 |
params.windowEndTime |
データが取得されるまでの日時。 この値は UNIX 時間で表されます。 |
応答
正常な応答は、新しく作成されたフロー実行の詳細(一意の実行を含む)を返します id
.
{
"items": [
{
"id": "3fb0418e-1804-45d6-8d56-dd51f05c0baf",
"etag": "\"1100c53e-0000-0200-0000-627138980000\""
}
]
}
プロパティ | 説明 |
---|---|
id |
新しく作成されたフロー実行の ID。 次のガイドを参照してください: フロー仕様の検索 を参照してください。 |
etag |
フロー実行のリソースのバージョン。 |
フロー実行が作成されたら、フロー実行を通じて取り込まれるデータを監視して、フロー実行、完了ステータス、エラーに関する情報を確認できます。 API を使用してフロー実行を監視するには、 API でのデータフローの監視. Platform UI を使用してフロー実行を監視するには、 監視ダッシュボードを使用したソースデータフローの監視.