Flow Service API を使用したデータベースの参照

最終更新日： 2025年4月4日

トピック：

作成対象：

開発者

このチュートリアルでは、Flow Service API を使用して、サードパーティのデータベースの内容とファイル構造を調べます。

はじめに

このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。

ソース：Experience Platform を使用すると、データを様々なソースから取得しながら、Experience Platform サービスを使用して受信データの構造化、ラベル付け、拡張を行うことができます。
サンドボックス：Experience Platform には、単一の Experience Platform インスタンスを別々の仮想環境に分割して、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。

次の節では、Flow Service API を使用してサードパーティデータベースに正常に接続するために必要な追加情報を示しています。

必要な資格情報の収集

このチュートリアルでは、データの取り込み元のサードパーティデータベースに対する有効な接続が必要です。有効な接続には、データベースの接続仕様 ID と接続 ID が含まれます。データベース接続の作成とこれらの値の取得について詳しくは、ソースコネクタの概要を参照してください。

API 呼び出し例の読み取り

このチュートリアルでは、API 呼び出しの例を提供し、リクエストの形式を設定する方法を示します。これには、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してくださいExperience Platform。

必須ヘッダーの値の収集

Experience Platform API を呼び出すには、まず認証チュートリアルを完了する必要があります。次に示すように、すべての Experience Experience Platform API 呼び出しで必要な各ヘッダーの値は認証チュートリアルで説明されています。

Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {ORG_ID}

Flow Serviceに属するリソースを含む、Experience Platform のすべてのリソースは、特定の仮想サンドボックスに分離されます。Experience Platform API へのすべてのリクエストには、操作がおこなわれるサンドボックスの名前を指定するヘッダーが必要です。

x-sandbox-name: {SANDBOX_NAME}

ペイロード（POST、PUT、PATCH）を含むすべてのリクエストには、メディアのタイプを指定する以下のような追加ヘッダーが必要です。

Content-Type: application/json

データテーブルの探索

データベースの接続 ID を使用すると、GET リクエストを実行してデータテーブルを調べることができます。次の呼び出しを使用して、検査または Experience Platform に取り込むテーブルのパスを検索します。

API 形式

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root

パラメーター

説明

{BASE_CONNECTION_ID}

データベースソースの接続 ID。

リクエスト

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/explore?objectType=root' \
    -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}'

応答

応答が成功すると、データベースからテーブルの配列が返されます。 Experience Platform に取り込むテーブルを見つけ、その path プロパティをメモします。これは、次の手順でその構造を検査するためにテーブルを指定する必要があるからです。

[
    {
        "type": "table",
        "name": "test1.Mytable",
        "path": "test1.Mytable",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "test1.austin_demo",
        "path": "test1.austin_demo",
        "canPreview": true,
        "canFetchSchema": true
    }
]

テーブルの構造を検査する

データベースからテーブルの構造を調べるには、テーブルのパスをクエリパラメーターとして指定して、GET リクエストを実行します。

API 形式

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}

パラメーター

説明

{BASE_CONNECTION_ID}

データベース接続の ID。

{TABLE_PATH}

テーブルのパス。

リクエスト

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/explore?objectType=table&object=test1.Mytable' \
    -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}'

応答

応答が成功すると、指定されたテーブルの構造が返されます。テーブルの各列に関する詳細は、columns 配列の要素内にあります。

{
    "format": "flat",
    "schema": {
        "columns": [
            {
                "name": "TestID",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Name",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            }
        ]
    }
}

次の手順

このチュートリアルに従って、データベースを探索し、Experience Platform に取り込むテーブルのパスを見つけ、その構造に関する情報を取得しました。次のチュートリアルでこの情報を使用してデータベースからデータを収集し、Experience Platformに取り込むことができます。

recommendation-more-help