フロー実行通知

最終更新日： 2025年10月14日

トピック：
Sources

作成対象：

Developer

Adobe Experience Platform では、外部ソースからデータを取り込むと同時に、Experience Platform サービスを使用して受信データの構造化、ラベル付け、および拡張を行うことができます。アドビのアプリケーション、クラウドベースのストレージ、データベースなど、様々なソースからデータを取り込むことができます。

Flow Service APIは、Experience Platform内のさまざまな異なるソースから顧客データを収集して一元化するために使用されます。このサービスは、ユーザーインターフェイスとRESTful APIを提供し、サポートされているすべてのソースを接続できます。

Adobe I/O Eventsでは、イベントを購読し、webhookを使用して、フロー実行のステータスに関する通知を受け取ることができます。これらの通知には、フロー実行の成功または実行の失敗の原因となったエラーに関する情報が含まれます。

このドキュメントでは、イベントの購読、webhookの登録、フロー実行のステータスに関する情報を含む通知の受信に関する手順を説明します。

はじめに

このチュートリアルでは、フローを監視するソース接続が少なくとも1つ作成されていることを前提としています。ソース接続をまだ設定していない場合は、このガイドに戻る前に、ソースの概要にアクセスして、選択したソースを設定します。

このドキュメントでは、Webhookに関する実用的な理解と、あるアプリケーションから別のアプリケーションにWebhookを接続する方法も必要です。 Webhook の概要については、I/O Events ドキュメントを参照してください。

フロー実行通知用のWebhookの登録

フロー実行の通知を受け取るには、Adobe Developer Consoleを使用してWebhookをExperience Platform統合に登録する必要があります。

この達成方法の詳細な手順については、「I/O Event通知の購読」のチュートリアルに従ってください。

IMPORTANT

サブスクリプションプロセス中に、イベントプロバイダーとして プラットフォーム通知 を選択し、次のイベントサブスクリプションを選択していることを確認します。

Experience Platform Sourceのフロー実行が成功しました
Experience Platform Sourceのフロー実行に失敗しました

フロー実行通知の受信

Webhookが接続され、イベントのサブスクリプションが完了すると、Webhook ダッシュボードを通じてフロー実行通知の受信を開始できます。

通知は、取り込みジョブの実行数、ファイルサイズ、エラーなどの情報を返します。通知は、JSON形式でフロー実行に関連付けられたペイロードも返します。応答ペイロードは、sources_flow_run_successまたはsources_flow_run_failureに分類できます。

IMPORTANT

フロー作成プロセス中に部分的な取り込みが有効になっている場合、成功した取り込みと失敗した取り込みの両方を含むフローは、エラー数がフロー作成プロセス中に設定されたエラーしきい値のパーセンテージを下回る場合にのみsources_flow_run_successとしてマークされます。正常なフロー実行にエラーが含まれている場合でも、これらのエラーはリターンペイロードの一部として含まれます。

成功

応答が成功すると、特定のフロー実行の特性を定義するmetricsと、データの変換方法の概要を示すactivitiesのセットが返されます。

{
  "event_id": "aec55616-1715-487f-8044-ba648cc8ffee",
  "event": {
    "createdAt": 1597213529158,
    "updatedAt": 1597213530760,
    "createdBy": "{CREATED_BY}",
    "updatedBy": "{UPDATED_BY}",
    "createdClient": "{CREATED_CLIENT}",
    "updatedClient": "{UPDATED_CLIENT}",
    "sandboxId": "7127a4f0-def8-11e9-83ce-e79494b1c2a5",
    "sandboxName": "prod",
    "imsOrgId": "{ORG_ID}",
    "id": "933cf9f4-cf01-4d75-bcf9-f4cf010d750a",
    "flowId": "1c6f1047-dcaf-48fe-af10-47dcaf08feaf",
    "providerRefId": "test1234",
    "etag": "\"5100ec97-0000-0200-0000-5f338b5b0000\"",
    "metrics": {
      "durationSummary": {
        "startedAtUTC": 1590512053,
        "completedAtUTC": 1590512053
      },
      "sizeSummary": {
        "inputBytes": 2048,
        "outputBytes": 1024
      },
      "recordSummary": {
        "inputRecordCount": 100,
        "outputRecordCount": 70
      },
      "fileSummary": {
        "inputFileCount": 10,
        "outputFileCount": 10
      },
      "statusSummary": {
        "status": "success"
      }
    },
    "activities": [
      {
        "id": "copyActivity",
        "updatedAtUTC": 87473822,
        "durationSummary": {
          "startedAtUTC": 1590512053,
          "completedAtUTC": 1590512053
        },
        "sizeSummary": {
          "inputBytes": 2048,
          "outputBytes": 1098
        },
        "recordSummary": {
          "inputRecordCount": 100,
          "outputRecordCount": 100
        },
        "fileSummary": {
          "inputFileCount": 10,
          "outputFileCount": 10
        },
        "statusSummary": {
          "status": "success",
          "extensions": {
            "adf/pipeline/id": "abcd",
            "adf/run/id": "1234"
          }
        },
        "sourceInfo": [
          {
            "id": "sourceConnectionId1",
            "type": "SourceConnection",
            "reference": {
              "type": "AdfRunId"
            }
          }
        ]
      },
      {
        "id": "promotionActivity",
        "updatedAtUTC": 87473822,
        "durationSummary": {
          "completedAtUTC": 1590512053
        },
        "sizeSummary": {
          "inputBytes": 1098,
          "outputBytes": 1024
        },
        "recordSummary": {},
        "fileSummary": {
          "inputFileCount": 10,
          "outputFileCount": 10,
          "extensions": {
            "manifest": {
              "fileInfo": "https://platform.adobe.io/data/foundation/export/batches/01E4TSJNM2H5M74J0XB8MFWDHK/meta?path=input_files"
            }
          }
        },
        "statusSummary": {
          "status": "success",
          "extensions": {
            "batchId": "b1",
            "acp_request_id": "1234"
          }
        },
        "targetInfo": [
          {
            "id": "targetConnectionId1",
            "type": "TargetConnection",
            "reference": {
              "type": "batch"
            }
          }
        ]
      }
    ],
    "slaCreatedAt": 1597213531124,
    "processStartTime": 1597213531213,
    "header": {
      "_adobeio": {
        "imsOrgId": "{ORG_ID}",
        "providerMetadata": "platform_notifications",
        "eventCode": "sources_flow_run_success"
      }
    },
    "transformedTime": 1597213531214
  }
}

プロパティ

説明

metrics

フロー実行のデータの特性を定義します。

activities

データを変換するために実行されるさまざまな手順とアクティビティを定義します。

durationSummary

フロー実行の開始と終了の時間を定義します。

sizeSummary

データのボリュームをバイト単位で定義します。

recordSummary

データのレコード数を定義します。

fileSummary

データのファイル数を定義します。

fileInfo

正常に取り込まれたファイルの概要につながるURL。

statusSummary

フロー実行が成功か失敗かを定義します。

失敗

次の応答は、コピーされたデータが処理されるときにエラーが発生する、失敗したフロー実行の例です。データがソースからコピーされている間にエラーが発生する可能性もあります。失敗したフロー実行には、エラーと説明など、実行の失敗に貢献したエラーに関する情報が含まれます。

[
  {
    "messages": [
      {
        "msgType": "eventNotification",
        "version": "1.0",
        "timestamp": 1597434157622,
        "imsOrgId": "{ORG_ID}",
        "schema": {
          "name": "run-notification",
          "version": "1.0"
        },
        "provider": "FlowService",
        "_eventNotificationMeta": {
          "category": "Platform Notifications",
          "type": "sources_flow_run_failed"
        },
        "value": {
          "createdAt": 1597434147259,
          "updatedAt": 1597434157567,
          "createdBy": "{CREATED_BY}",
          "updatedBy": "{UPDATED_BY}",
          "createdClient": "{CREATED_CLIENT}",
          "updatedClient": "{UPDATED_CLIENT}",
          "sandboxId": "e49ebb00-d0fa-11e9-b164-ed6a398c8b35",
          "sandboxName": "prod",
          "imsOrgId": "{ORG_ID}",
          "id": "d9024c32-2174-4271-824c-322174627101",
          "flowId": "cf4fce79-8822-456d-8fce-798822556dc6",
          "etag": "\"0c003dbf-0000-0200-0000-5f36e92d0000\"",
          "metrics": {
            "durationSummary": {
              "startedAtUTC": 1597434147190
            },
            "sizeSummary": {
              "inputBytes": -1
            },
            "fileSummary": {
              "inputFileCount": -1
            },
            "statusSummary": {
              "status": "failed",
              "errors": [
                {
                  "code": "CONNECTOR-2001-500",
                  "message": "Error in processing (parsing, validation or transformation) the copied data."
                }
              ]
            }
          },
          "activities": [
            {
              "id": "promotionActivity",
              "updatedAtUTC": 1597434157529,
              "durationSummary": {
                "startedAtUTC": 1597434147190,
                "completedAtUTC": 1597434157212
              },
              "sizeSummary": {
                "inputBytes": -1
              },
              "recordSummary": {},
              "fileSummary": {
                "inputFileCount": -1,
                "extensions": {
                  "manifest": {
                    "fileInfo": "https://platform-stage.adobe.io/data/foundation/export/batches/6f6a900f-e40d-4f0e-9bb9-b614436c3465/meta?path=input_files"
                  }
                }
              },
              "statusSummary": {
                "status": "failed",
                "errors": [
                  {
                    "code": "CONNECTOR-2001-500",
                    "message": "Error in processing (parsing, validation or transformation) the copied data."
                  }
                ],
                "extensions": {
                  "errors": [
                    {
                      "code": "133",
                      "message": "We are unable to locate any files uploaded for this batch. Please upload files to ingest."
                    }
                  ]
                }
              },
              "targetInfo": [
                {
                  "id": "e88737aa-27b8-4795-8737-aa27b8f7959e",
                  "type": "TargetConnection",
                  "reference": {
                    "type": "Batch",
                    "ids": [
                      "6f6a900f-e40d-4f0e-9bb9-b614436c3465"
                    ]
                  }
                }
              ]
            }
          ]
        }
      }
    ]
  }
]

プロパティ

説明

fileInfo

正常に取り込まれたファイルと正常に取り込まれなかったファイルの概要につながるURL。

NOTE

エラーメッセージについて詳しくは、付録を参照してください。

次の手順

フロー実行ステータスに関するリアルタイム通知を受信できるイベントを購読できるようになりました。フロー実行とソースについて詳しくは、ソースの概要を参照してください。

付録

次の節では、フロー実行通知の操作に関する追加情報を示します。

エラーメッセージについて errors

取り込みエラーは、データがソースからコピーされている場合、またはコピーされたデータがExperience Platformに処理されている場合に発生する可能性があります。特定のエラーについて詳しくは、以下の表を参照してください。

エラー

説明

CONNECTOR-1001-500

ソースからデータをコピー中にエラーが発生しました。

CONNECTOR-2001-500

コピーされたデータをExperience Platformに処理中にエラーが発生しました。このエラーは、解析、検証、または変換に関するエラーです。

recommendation-more-help

experience-platform-help-sources