このチュートリアルでは、 Flow Service API
このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。
Platform API を正常に呼び出す方法について詳しくは、Platform API の概要のガイドを参照してください。
GETリクエストを Flow Service ソースのベース接続 ID を提供する際の API。
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
}
]
データテーブルの内容を調べるには、に対してGETリクエストを実行します。 Flow Service テーブルのパスをクエリパラメーターとして指定する際の API。
API 形式
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}
パラメーター | 説明 |
---|---|
{BASE_CONNECTION_ID} |
ソースのベース接続 ID。 |
{TABLE_PATH} |
検査するテーブルの 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: