Flow Service API を使用したデータテーブルの調査

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

トピック：

作成対象：

開発者

このチュートリアルでは、Flow Service API を使用してデータテーブルの構造と内容を調査およびプレビューする手順を説明します。

NOTE

データテーブルを調べるには、表形式のソースに対して有効なベース接続 ID が必要です。この ID を持っていない場合は、次のチュートリアルで、表形式のソースのベース接続 ID を作成する手順を確認してください。

はじめに

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

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

Platform API の使用

Platform API を正常に呼び出す方法について詳しくは、Platform API の概要のガイドを参照してください。

データテーブルの探索

ソースのベース接続 ID を指定したうえで Flow Service API に対してデータリクエストを行うことで、GETテーブルの構造に関する情報を取得できます。

API 形式

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

パラメーター

説明

{BASE_CONNECTION_ID}

ソースのベース接続 ID。

リクエスト

curl -X GET \
  'https://platform.adobe.io/data/foundation/flowservice/connections/5e73e5a2-dc36-45a8-9f16-93c7a43af318/explore?objectType=root' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

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

[
    {
        "type": "table",
        "name": "ACME Spring Campaign",
        "path": "acmeSpringCampaign",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "ACME Summer Campaign",
        "path": "acmeSummerCampaign",
        "canPreview": true,
        "canFetchSchema": true
    }
]

テーブルの構造のInspect

データテーブルの内容を調べるには、テーブルのパスをクエリパラメーターとして指定して、Flow Service API に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/5e73e5a2-dc36-45a8-9f16-93c7a43af318/explore?objectType=table&object=acmeSpringCampaign' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -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"
        }
      },
      {
        "name": "Datefield",
        "type": "string",
        "meta:xdmType": "date-time",
        "xdm": {
          "type": "string",
          "format": "date-time"
        }
      },
      {
        "name": "complaint_type",
        "type": "string",
        "xdm": {
          "type": "string"
        }
      },
      {
        "name": "complaint_description",
        "type": "string",
        "xdm": {
          "type": "string"
        }
      },
      {
        "name": "status",
        "type": "string",
        "xdm": {
          "type": "string"
        }
      },
      {
        "name": "status_change_date",
        "type": "string",
        "meta:xdmType": "date-time",
        "xdm": {
          "type": "string",
          "format": "date-time"
        }
      },
      {
        "name": "city",
        "type": "string",
        "xdm": {
          "type": "string"
        }
      },
      {
        "name": "Datefield2",
        "type": "string",
        "meta:xdmType": "date-time",
        "xdm": {
          "type": "string",
          "format": "date-time"
        }
      }
    ]
  }
}

次の手順

このチュートリアルでは、データテーブルの構造と内容に関する情報を収集しました。さらに、Platform に取り込むテーブルへのパスを取得しました。この情報を使用して、ソース接続とデータフローを作成し、データを Platform に取り込むことができます。 Flow Service API を使用してソース接続とデータフローを作成する方法に関する具体的な手順については、次のチュートリアルを参照してください。

recommendation-more-help

337b99bb-92fb-42ae-b6b7-c7042161d089