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

このチュートリアルでは、 Flow Service API (サードパーティのクラウドストレージシステム)を使用して調査します。

はじめに

このガイドでは、Adobe Experience Platform の次のコンポーネントに関する作業を理解している必要があります。

  • ソース: Experience Platform 様々なソースからデータを取り込むことができ、 Platform サービスを使用してデータの構造化、ラベル付け、および入力データの拡張を行うことができます。
  • サンドボックス: Experience Platform は、1つの Platform インスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスを提供します。

The following sections provide additional information that you will need to know in order to successfully connect to a cloud storage system using the Flow Service API.

接続IDの取得

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

API 呼び出し例の読み取り

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

必須ヘッダーの値の収集

In order to make calls to Platform APIs, you must first complete the authentication tutorial. Completing the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:

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

All resources in Experience Platform, including those belonging to Flow Service, are isolated to specific virtual sandboxes. All requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in:

  • x-sandbox-name: {SANDBOX_NAME}

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

  • Content-Type: application/json

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

クラウドストレージの接続IDを使用して、GETリクエストを実行することで、ファイルやディレクトリを調べることができます。 クラウドストレージを調査するためのGETリクエストを実行する場合は、次の表に示すクエリパラメーターを含める必要があります。

パラメーター 説明
objectType 調査するオブジェクトのタイプ。 この値は次のいずれかに設定します。
  • folder:特定のディレクトリの参照
  • root:ルートディレクトリを調べます。
object このパラメーターは、特定のディレクトリを表示する場合にのみ必要です。 この値は、調査するディレクトリのパスを表します。

次の呼び出しを使用して、に取り込むファイルのパスを探しま Platformす。

API 形式

GET /connections/{CONNECTION_ID}/explore?objectType=root
GET /connections/{CONNECTION_ID}/explore?objectType=folder&object={PATH}
パラメーター 説明
{CONNECTION_ID} クラウドストレージソースコネクタの接続ID。
{PATH} ディレクトリのパス。

リクエスト

curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/{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"
    }
]

ファイルの構造をInspectにする

クラウドストレージーからGETファイルの構造を検査するには、ファイルのパスを指定し、クエリーパラメーターとして入力しながらデータリクエストを実行します。

カスタムの区切り文字をクエリの枠として指定することで、CSVまたはTSVファイルの構造を調べることができます。 任意の1文字の値は、列の区切り文字として使用できます。 指定しない場合、コンマ (,) がデフォルト値として使用されます。

API 形式

GET /connections/{CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&fileType={FILE_TYPE}
GET /connections/{CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&fileType={FILE_TYPE}&preview=true&fileType=delimited&columnDelimiter=;
GET /connections/{CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&fileType={FILE_TYPE}&preview=true&fileType=delimited&columnDelimiter=\t
パラメーター 説明
{CONNECTION_ID} クラウドストレージソースコネクタの接続ID。
{FILE_PATH} 検査するファイルへのパスです。
{FILE_TYPE} ファイルの種類です。 次のファイルタイプがサポートされています。
  • 区切り文字:区切り文字区切り値。 DSVファイルはコンマで区切る必要があります。
  • JSON:JavaScriptオブジェクト表記を参照してください。 JSONファイルはXDMに準拠している必要があります
  • パーケ:Apacheパーケー。 パーケファイルはXDMに準拠している必要があります。
columnDelimiter CSVファイルまたはTSVファイルを検査するための列区切り文字として指定した1文字の値。 パラメーターを指定しない場合、値のデフォルトはコンマで (,)す。

リクエスト

curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/{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ました。 次のチュートリアルでこの情報を使用して、クラウドストレージからデータを 収集し、Platformに取り込むことができます

このページ