[ベータ版]{class="badge informative"}

Flow Service APIを使用してYOURSOURCE データをストリーミングするソース接続とデータフローを作成します

最終更新日： 2025年11月12日

トピック：
Sources

作成対象：

{"id":"ff6a42d2-313e-452e-93a6-792e4fad9ff8"}

このテンプレートを使用する際に、斜体のすべての段落（この段落から始まる）を置き換えるか削除します。

最初に、ページ上部のメタデータ（タイトルと説明）を更新します。このページのDNLのインスタンスはすべて無視してください。これは、機械翻訳プロセスが適切にサポートする複数の言語にページを翻訳するのに役立つタグです。ドキュメントを送信すると、ドキュメントにタグが追加されます。

概要

顧客に提供する価値を含め、会社の概要を簡単に説明します。製品ドキュメントのホームページへのリンクを追加して、詳細をご覧ください。

IMPORTANT

このソースコネクタとドキュメントのページは、YOURSOURCE チームによって作成および管理されています。お問い合わせやアップデートのリクエストについては、更新にアクセスできるリンクまたはメールアドレスを挿入で直接連絡してください。

前提条件

Adobe Experience Platform ユーザーインターフェイスでソースの設定を開始する前に、お客様が認識しておく必要がある情報をこのセクションに追加します。次の程度である可能性があります：

様は許可リストに追加する必要があります
電子メールハッシュの要件
お客様の側にあるアカウントの詳細
プラットフォームに接続するためのAPI キーを取得する方法

必要な資格情報の収集

YOURSOURCEをExperience Platformに接続するには、次の接続プロパティの値を指定する必要があります。

資格情報

説明

例

資格情報1

ソースの認証資格情報に簡単な説明をここに追加してください

ソースの認証情報の例をここに追加してください

資格情報2

ソースの認証資格情報に簡単な説明をここに追加してください

ソースの認証情報の例をここに追加してください

資格情報3

ソースの認証資格情報に簡単な説明をここに追加してください

ソースの認証情報の例をここに追加してください

これらの資格情報について詳しくは、YOURSOURCE認証ドキュメントを参照してください。 プラットフォームの認証ドキュメントへのリンクをここに追加してください。

YOURSOURCEをWebhookと統合する

ストリーミング SDKでは、Experience Platformと通信するためにWebhookをサポートできるソースが必要です。このセクションでは、ソースをWebhookと統合するためにユーザーが実行する必要がある手順を指定する必要があります。

Flow Service APIを使用して YOURSOURCE をExperience Platformに接続します

次のチュートリアルでは、Flow Service APIを使用してYOURSOURCE ソース接続を作成し、YOURSOURCE データをExperience Platformに取り込むデータフローを作成する手順について説明します。

ソース接続の作成 source-connection

ソースの接続仕様ID、名前と説明などの詳細、データの形式を指定しながら、Flow Service APIにPOST リクエストを実行して、ソース接続を作成します。

API 形式

POST /sourceConnections

リクエスト

次のリクエストは、YOURSOURCEのソース接続を作成します。

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
  -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 '{
      "name": "Streaming Source Connection for a Streaming SDK source",
      "providerId": "521eee4d-8cbe-4906-bb48-fb6bd4450033",
      "description": "Streaming Source Connection for a Streaming SDK source",
      "connectionSpec": {
          "id": "e77fd9d2-22a8-11ed-861d-0242ac120002",
          "version": "1.0"
      },
      "data": {
          "format": "json"
      }
    }'

プロパティ

説明

name

ソース接続の名前。ソース接続の情報を検索する際に使用できるので、ソース接続の名前はわかりやすいものにしてください。

description

含めることでソース接続に関する詳細情報を提供できるオプションの値です。

connectionSpec.id

ソースに対応する接続仕様の ID。

data.format

取り込むYOURSOURCE データの形式。現在、サポートされているデータ形式は json のみです。

応答

リクエストが成功した場合は、新たに作成されたソース接続の一意の ID（id）が返されます。この ID は、後の手順でデータフローを作成する際に必要になります。

{
     "id": "246d052c-da4a-494a-937f-a0d17b1c6cf5",
     "etag": "\"712a8c08-fda7-41c2-984b-187f823293d8\""
}

ターゲット XDM スキーマの作成 target-schema

ソースデータをExperience Platformで使用するには、必要に応じてソースデータを構造化するターゲットスキーマを作成する必要があります。その後、ターゲットスキーマを使用して、ソースデータが含まれるExperience Platform データセットを作成します。

Schema Registry API に POST リクエストを実行することで、ターゲット XDM スキーマを作成できます。

ターゲット XDM スキーマの作成手順について詳しくは、 API を使用したスキーマの作成に関するチュートリアルを参照してください。

ターゲットデータセットの作成 target-dataset

Catalog Service API に POST リクエストを実行し、その際にペイロード内でターゲットスキーマの ID を指定することで、ターゲットデータセットを作成できます。

ターゲットデータセットの作成手順について詳しくは、 API を使用したデータセットの作成に関するチュートリアルを参照してください。

ターゲット接続の作成 target-connection

ターゲット接続は、取り込んだデータを格納する宛先への接続を表します。ターゲット接続を作成するには、データレイクに対応する固定接続仕様IDを指定する必要があります。この ID は c604ff05-7f1a-43c0-8e18-33bf874cb11c です。

ターゲットスキーマ、ターゲットデータセット、データレイクへの接続仕様IDなどの一意の識別子が作成されました。これらの識別子を使用すると、受信ソースデータを格納するデータセットを指定する Flow Service API を使用して、ターゲット接続を作成することができます。

API 形式

POST /targetConnections

リクエスト

次のリクエストは、YOURSOURCEのターゲット接続を作成します。

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
  -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 '{
      "name": "Streaming Target Connection for a Streaming SDK source",
      "description": "Streaming Target Connection for a Streaming SDK source",
      "connectionSpec": {
          "id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
          "version": "1.0"
      },
      "data": {
          "format": "json",
          "schema": {
              "id": "{TARGET_XDM_SCHEMA}",
              "version": "application/vnd.adobe.xed-full+json;version=1"
          }
      },
      "params": {
          "dataSetId": "{TARGET_DATASET}"
      }
  }'

プロパティ

説明

name

ターゲット接続の名前。ターゲット接続の情報を検索に使用できるように、ターゲット接続はわかりやすい名前にしてください。

description

ターゲット接続に関する詳細を提供するために含めることができるオプションの値です。

connectionSpec.id

データレイクに対応する接続仕様ID。この修正済み ID は c604ff05-7f1a-43c0-8e18-33bf874cb11c です。

data.format

Experience Platformに取り込むYOURSOURCE データのフォーマット。

params.dataSetId

前の手順で取得したターゲットデータセット ID。

応答

リクエストが成功した場合は、新しいターゲット接続の一意の ID（id）が返されます。この ID は、後の手順で必要になります。

{
     "id": "7c96c827-3ffd-460c-a573-e9558f72f263",
     "etag": "\"a196f685-f5e8-4c4c-bfbd-136141bb0c6d\""
}

マッピングの作成 mapping

ソースデータをターゲットデータセットに取り込むには、まず、ターゲットデータセットが準拠するターゲットスキーマにマッピングする必要があります。これは、リクエストペイロード内で定義されたデータマッピングを使用して、Data Prep APIに対してPOST リクエストを実行することで実現します。

API 形式

POST /conversion/mappingSets

リクエスト

curl -X POST \
  'https://platform.adobe.io/data/foundation/mappingSets' \
  -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 '{
      "version": 0,
      "xdmSchema": "{TARGET_XDM_SCHEMA}",
      "xdmVersion": "1.0",
      "mappings": [
          {
              "destinationXdmPath": "person.name.firstName",
              "sourceAttribute": "firstName",
              "identity": false,
              "version": 0
          },
          {
              "destinationXdmPath": "person.name.lastName",
              "sourceAttribute": "lastName",
              "identity": false,
              "version": 0
          }
      ]
  }'

プロパティ

説明

xdmSchema

以前の手順で生成されたターゲット XDM スキーマの ID。

mappings.destinationXdmPath

ソース属性がマッピングされている宛先 XDM パス。

mappings.sourceAttribute

宛先 XDM パスにマッピングする必要があるソース属性。

mappings.identity

マッピングセットに Identity Service のマークを付けるかどうかを指定するブール値。

応答

リクエストが成功した場合は、一意の ID（id）を含む、新しく作成されたマッピングの詳細が返されます。この値は、後の手順でデータフローを作成する際に必要になります。

{
    "id": "bf5286a9c1ad4266baca76ba3adc9366",
    "version": 0,
    "createdDate": 1597784069368,
    "modifiedDate": 1597784069368,
    "createdBy": "{CREATED_BY}",
    "modifiedBy": "{MODIFIED_BY}"
}

フローの作成 flow

YOURSOURCEからExperience Platformにデータを取り込む最後の手順は、データフローを作成することです。現時点で、次の必要な値の準備ができています。

ソース接続 ID
ターゲット接続 ID
マッピング ID

データフローは、ソースからデータをスケジュールおよび収集する役割を果たします。ペイロードに前述の値を提供しながら POST リクエストを実行することで、データフローを作成することができます。

API 形式

POST /flows

リクエスト

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/flows' \
  -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 '{
      "name": "Streaming Dataflow for a Streaming SDK source",
      "description": "Streaming Dataflow for a Streaming SDK source",
      "flowSpec": {
          "id": "e77fde5a-22a8-11ed-861d-0242ac120002",
          "version": "1.0"
      },
      "sourceConnectionIds": [
          "246d052c-da4a-494a-937f-a0d17b1c6cf5"
      ],
      "targetConnectionIds": [
          "7c96c827-3ffd-460c-a573-e9558f72f263"
      ],
      "transformations": [
      {
        "name": "Mapping",
        "params": {
          "mappingId": "bf5286a9c1ad4266baca76ba3adc9366",
          "mappingVersion": 0
        }
      }
    ]
  }'

プロパティ

説明

name

データフローの名前。データフローの情報を検索する際に使用できるので、データフローはわかりやすい名前にしてください。

description

データフローに関する詳細情報を提供するために含めることができるオプション値。

flowSpec.id

データフローの作成に必要なフロー仕様 ID。この修正済み ID は e77fde5a-22a8-11ed-861d-0242ac120002 です。

flowSpec.version

フロー仕様 ID の対応するバージョン。この値のデフォルトは 1.0 です。

sourceConnectionIds

以前の手順で生成されたソース接続 ID。

targetConnectionIds

以前の手順で生成されたターゲット接続 ID。

transformations

このプロパティには、データに適用する必要がある様々な変換が含まれています。このプロパティは、XDMに準拠していないデータをExperience Platformに取り込む場合に必要です。

transformations.name

変換に割り当てられた名前。

transformations.params.mappingId

以前の手順で生成されたマッピング ID。

transformations.params.mappingVersion

マッピング ID の対応するバージョン。この値のデフォルトは 0 です。

応答

正常な応答は、新しく作成したデータフローの ID（id）を返します。この ID を使用して、データフローを監視、更新または削除できます。

{
     "id": "993f908f-3342-4d9c-9f3c-5aa9a189ca1a",
     "etag": "\"510bb1d4-8453-4034-b991-ab942e11dd8a\""
}

ストリーミングエンドポイント URLの取得

データフローを作成したら、ストリーミングエンドポイント URLを取得できるようになりました。このエンドポイント URLを使用して、ソースをWebhookに登録し、ソースがExperience Platformと通信できるようにします。

ストリーミングエンドポイント URLを取得するには、/flows エンドポイントにGET リクエストを行い、データフローのIDを指定します。

API 形式

GET /flows/{FLOW_ID}

リクエスト

curl -X GET \
  'https://platform.adobe.io/data/foundation/flowservice/flows/993f908f-3342-4d9c-9f3c-5aa9a189ca1a' \
  -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}'

応答

応答が成功すると、inletUrlとしてマークされたエンドポイント URLを含む、データフローに関する情報が返されます。

{
  "items": [
    {
      "id": "993f908f-3342-4d9c-9f3c-5aa9a189ca1a",
      "createdAt": 1669238699119,
      "updatedAt": 1669238699119,
      "createdBy": "acme@AdobeID",
      "updatedBy": "acme@AdobeID",
      "createdClient": "{CREATED_CLIENT}",
      "updatedClient": "{UPDATED_CLIENT}",
      "sandboxId": "{SANDBOX_ID}",
      "sandboxName": "{SANDBOX_NAME}",
      "imsOrgId": "{ORG_ID}",
      "name": "Streaming Dataflow for a Streaming SDK source",
      "description": "Streaming Dataflow for a Streaming SDK source",
      "flowSpec": {
        "id": "e77fde5a-22a8-11ed-861d-0242ac120002",
        "version": "1.0"
      },
      "state": "enabled",
      "version": "\"a1011225-0000-0200-0000-63c78ae60000\"",
      "etag": "\"a1011225-0000-0200-0000-63c78ae60000\"",
      "sourceConnectionIds": [
        "246d052c-da4a-494a-937f-a0d17b1c6cf5"
      ],
      "targetConnectionIds": [
        "7c96c827-3ffd-460c-a573-e9558f72f263"
      ],
      "inheritedAttributes": {
        "properties": {
          "isSourceFlow": true
        },
        "sourceConnections": [
          {
            "id": "246d052c-da4a-494a-937f-a0d17b1c6cf5",
            "connectionSpec": {
              "id": "bdb5b792-451b-42de-acf8-15f3195821de",
              "version": "1.0"
            }
          }
        ],
        "targetConnections": [
          {
            "id": "7c96c827-3ffd-460c-a573-e9558f72f263",
            "connectionSpec": {
              "id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
              "version": "1.0"
            }
          }
        ]
      },
      "options": {
        "errorDiagnosticsEnabled": true,
        "inletUrl": "https://dcs-int.adobedc.net/collection/ab65636c31778fb0455c439ffb48a5433a34d443f4c83c4b5beda9c5688797c5"
      },
      "transformations": [
        {
          "name": "Mapping",
          "params": {
            "mappingVersion": 0,
            "mappingId": "bf5286a9c1ad4266baca76ba3adc9366"
          }
        }
      ],
      "runs": "/runs?property=flowId==e1514b79-f031-43b4-aab5-381a42f86ad4",
      "providerRefId": "c9809ab5-71e0-4c7f-887b-61c95e4e20b5",
      "lastOperation": {
        "started": 0,
        "updated": 0,
        "operation": "enable"
      }
    }
  ]
}

付録

次の節では、データフローを監視、更新、削除する手順について説明します。

データフローの監視

データフローが作成されると、それを通して取り込まれるデータを監視し、フローの実行状況、完了状況、エラーなどの情報を確認することができます。完全なAPIの例については、APIを使用したソースデータフローの監視に関するガイドを参照してください。

データフローの更新

データフローのIDを指定しながら、Flow Service APIの/flows エンドポイントに対してPATCH リクエストを行うことで、データフローの名前や説明、実行スケジュールおよび関連するマッピングセットなどの詳細を更新します。 PATCH リクエストを行う場合は、If-Match ヘッダーにデータフローの一意のetagを指定する必要があります。完全なAPI例については、APIを使用したソースデータフローの更新に関するガイドを参照してください

アカウントを更新

ベース接続IDをクエリパラメーターとして指定しながら、Flow Service APIに対してPATCH リクエストを実行して、ソースアカウントの名前、説明、資格情報を更新します。 PATCH リクエストを行う場合、If-Match ヘッダーにソースアカウントの一意のetagを指定する必要があります。完全なAPIの例については、APIを使用したソースアカウントの更新に関するガイドを参照してください。

データフローの削除

クエリパラメーターの一部として削除するデータフローのIDを指定しながら、Flow Service APIに対してDELETE リクエストを実行して、データフローを削除します。完全なAPIの例については、APIを使用したデータフローの削除に関するガイドを参照してください。

アカウントを削除

削除するアカウントのベース接続IDを指定しながら、Flow Service APIに対してDELETE リクエストを実行して、アカウントを削除します。完全なAPIの例については、APIを使用したソースアカウントの削除に関するガイドを参照してください。

recommendation-more-help

experience-platform-help-sources

Flow Service APIを使用して​YOURSOURCE データをストリーミングするソース接続とデータフローを作成します

概要

前提条件

必要な資格情報の収集

YOURSOURCE​をWebhookと統合する

Flow Service APIを使用して​ YOURSOURCE ​をExperience Platformに接続します

ソース接続の作成 source-connection

ターゲット XDM スキーマの作成 target-schema

ターゲットデータセットの作成 target-dataset

ターゲット接続の作成 target-connection

マッピングの作成 mapping

フローの作成 flow

ストリーミングエンドポイント URLの取得

付録

データフローの監視

データフローの更新

アカウントを更新

データフローの削除

アカウントを削除

Flow Service APIを使用してYOURSOURCE データをストリーミングするソース接続とデータフローを作成します

YOURSOURCEをWebhookと統合する

Flow Service APIを使用して YOURSOURCE をExperience Platformに接続します