Show Menu
トピック×

Flow Service APIを使用したクラウドストレージシステムの調査

フローサービスは、Adobe Experience Platform内の様々な異なるソースから顧客データを収集し、一元管理するために使用します。 このサービスは、ユーザーインターフェイスとRESTful APIを提供し、サポートされるすべてのソースを接続できます。
このチュートリアルでは、Flow Service APIを使用して、サードパーティのクラウドストレージシステムを調査します。

はじめに

このガイドでは、Adobe Experience Platformの次のコンポーネントについて、十分に理解している必要があります。
  • ソース : Experience Platformを使用すると、様々なソースからデータを取り込むと同時に、プラットフォームサービスを使用して、入力データの構造、ラベル付け、拡張を行うことができます。
  • サンドボックス : Experience Platformは、1つのプラットフォームインスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスを提供します。
Flow Service APIを使用してクラウドストレージシステムに正常に接続するために必要な追加情報については、以下の節で説明します。

ベース接続の取得

Platform APIを使用してサードパーティのクラウドストレージを調査するには、有効なベース接続IDが必要です。 操作するストレージの基本接続がまだない場合は、次のチュートリアルを使用して作成できます。

サンプルAPI呼び出しの読み取り

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

必要なヘッダーの値の収集

プラットフォームAPIを呼び出すには、まず 認証チュートリアルを完了する必要があります 。 次に示すように、認証チュートリアルで、すべてのExperience Platform API呼び出しに必要な各ヘッダーの値を指定します。
  • 認証: 無記名 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Experience Platformのすべてのリソース(フローサービスに属するリソースを含む)は、特定の仮想サンドボックスに分離されます。 プラットフォームAPIへのすべてのリクエストには、操作が実行されるサンドボックスの名前を指定するヘッダーが必要です。
  • x-sandbox-name: {SANDBOX_NAME}
ペイロード(POST、PUT、PATCH)を含むすべての要求には、追加のメディアタイプヘッダーが必要です。
  • Content-Type: application/json

クラウドストレージの利用

クラウドストレージの基本接続を使用して、GETリクエストを実行することで、ファイルやディレクトリを調べることができます。 クラウドストレージを調査するGETリクエストを実行する場合、次の表に示すクエリパラメーターを含める必要があります。
パラメーター
説明
objectType
調査するオブジェクトのタイプ。 この値は次のいずれかに設定します。
  • folder : 特定のディレクトリの参照
  • root : ルートディレクトリを調べます。
object
このパラメーターは、特定のディレクトリを表示する場合にのみ必要です。 この値は、調査するディレクトリのパスを表します。
次の呼び出しを使用して、プラットフォームに取り込むファイルのパスを探します。
API形式
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=folder&object={PATH}

パラメーター
説明
{BASE_CONNECTION_ID}
クラウドストレージベースの接続のID。
{PATH}
ディレクトリのパス。
リクエスト
curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/{BASE_CONNECTION_ID}/explore?objectType=folder&object=/some/path/' \
    -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}'

応答
正常な応答は、照会されたディレクトリ内のファイルとフォルダの配列を返します。 アップロードするファイルの path プロパティを控えておきます。次の手順でその構造を調べる必要があります。
[
    {
        "type": "File",
        "name": "data.csv",
        "path": "/some/path/data.csv"
    },
    {
        "type": "Folder",
        "name": "foobar",
        "path": "/some/path/foobar"
    }
]

ファイルの構造を検査する

クラウドストレージーからデータファイルの構造を検査するには、ファイルのパスをクエリーパラメーターとして指定しながら、GETリクエストを実行します。
API形式
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&fileType={FILE_TYPE}

パラメーター
説明
{BASE_CONNECTION_ID}
クラウドストレージベースの接続のID。
{FILE_PATH}
ファイルへのパス。
{FILE_TYPE}
ファイルの種類です。 次のファイルタイプがサポートされています。
  • 区切り文字: 区切り文字区切り値。 DSVファイルはコンマで区切る必要があります。
  • JSON: JavaScriptオブジェクト表記を参照してください。 JSONファイルはXDMに準拠している必要があります
  • パーケ: Apacheパーケー。 パーケファイルはXDMに準拠している必要があります。
リクエスト
curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/{BASE_CONNECTION_ID}/explore?objectType=file&object=/some/path/data.csv&fileType=DELIMITED' \
    -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}'

応答
成功した応答は、クエリー対象のファイルの構造(テーブル名とデータ型を含む)を返します。
[
    {
        "name": "Id",
        "type": "String"
    },
    {
        "name": "FirstName",
        "type": "String"
    },
    {
        "name": "LastName",
        "type": "String"
    },
    {
        "name": "Email",
        "type": "String"
    },
    {
        "name": "Phone",
        "type": "String"
    }
]

次の手順

このチュートリアルに従って、クラウドストレージシステムを調べ、プラットフォームに取り込むファイルのパスを見つけ、その構造を確認しました。 次のチュートリアルでこの情報を使用して、クラウドストレージからデータを 収集し、Platformに取り込むことができます