使用Flow Service API探索您的雲端儲存資料夾
建立對象:
- 開發人員
本教學課程提供如何使用Flow Service API來探索及預覽雲端儲存空間的結構與內容的步驟。
快速入門
本指南需要您深入了解下列 Adobe Experience Platform 元件:
使用Experience Platform API
如需如何成功呼叫Experience Platform API的詳細資訊,請參閱Experience Platform API快速入門指南。
探索您的雲端儲存資料夾
您可以在提供來源的基本連線ID時,對Flow Service API發出GET要求,以擷取有關雲端儲存資料夾結構的資訊。
執行GET請求以探索您的雲端儲存空間時,您必須包含下表所列的查詢引數:
參數 | 說明 |
---|---|
objectType |
您要探索的物件型別。 將此值設定為:
|
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/dc3c0646-5e30-47be-a1ce-d162cb8f1f07/explore?objectType=folder&object=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}'
回應
成功的回應會傳回在查詢的目錄中找到的檔案和資料夾陣列。 記下您要上傳之檔案的path
屬性,因為您必須在下個步驟中提供該屬性,才能檢查其結構。
[
{
"type": "file",
"name": "account.csv",
"path": "/test-connectors/testFolder-fileIngestion/account.csv",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "file",
"name": "profileData.json",
"path": "/test-connectors/testFolder-fileIngestion/profileData.json",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "file",
"name": "sampleprofile--3.parquet",
"path": "/test-connectors/testFolder-fileIngestion/sampleprofile--3.parquet",
"canPreview": true,
"canFetchSchema": true
}
]
檢查檔案的結構
若要從雲端儲存空間檢查資料檔案的結構,請在提供檔案路徑及型別作為查詢引數的同時,執行GET要求。
您可以在提供檔案路徑和型別的同時,執行GET要求,從雲端儲存空間來源檢查資料檔案的結構。 您也可以檢查不同的檔案型別(例如CSV、TSV或壓縮的JSON)和分隔檔案,方法是將其檔案型別指定為查詢引數的一部分。
API格式
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&fileType={FILE_TYPE}&{QUERY_PARAMS}&preview=true
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&preview=true&fileType=delimited&columnDelimiter=\t
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&preview=true&fileType=delimited&compressionType=gzip;
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=FILE&object={FILE_PATH}&preview=true&fileType=delimited&encoding=ISO-8859-1;
{BASE_CONNECTION_ID}
{FILE_PATH}
{FILE_TYPE}
檔案的型別。 支援的檔案型別包括:
已分隔
:以分隔符號分隔的值。 DSV檔案必須以逗號分隔。JSON
:JavaScript物件標籤法。 JSON檔案必須符合XDM標準PARQUET
:Apache Parquet。 Parquet檔案必須符合XDM標準。
{QUERY_PARAMS}
要求
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/{BASE_CONNECTION_ID}/explore?objectType=file&object=/aep-bootcamp/Adobe%20Pets%20Customer%2020190801%20EXP.json&fileType=json&preview=true' \
-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}'
回應
成功的回應會傳回查詢檔案的結構,包括表格名稱和資料型別。
[
{
"name": "Id",
"type": "String"
},
{
"name": "FirstName",
"type": "String"
},
{
"name": "LastName",
"type": "String"
},
{
"name": "Email",
"type": "String"
},
{
"name": "Phone",
"type": "String"
}
]
使用查詢引數
Flow Service API支援使用查詢引數來預覽和檢查不同的檔案型別。
columnDelimiter
(,)
。compressionType
預覽壓縮的分隔檔案或JSON檔案所需的查詢引數。 支援的壓縮檔案包括:
bzip2
gzip
deflate
zipDeflate
tarGzip
tar
encoding
UTF-8
和ISO-8859-1
。 注意: encoding
引數僅在擷取分隔的CSV檔案時可用。 將使用預設編碼UTF-8
擷取其他檔案型別。後續步驟
依照本教學課程,您已探索您的雲端儲存系統、找到您要帶入Experience Platform的檔案路徑,並檢視其結構。 您可以在下個教學課程中使用此資訊,從您的雲端儲存空間收集資料,並將其帶入Experience Platform。