使用Flow Service API探索您的雲端儲存資料夾

Last update: Fri Apr 04 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

主題：

建立對象：

開發人員

本教學課程提供如何使用Flow Service API來探索及預覽雲端儲存空間的結構與內容的步驟。

NOTE

為了探索您的雲端儲存空間，您必須擁有雲端儲存空間來源的有效基本連線ID。如果您沒有此ID，請參閱來源概觀，以取得您可以用來建立基礎連線的雲端儲存空間來源清單。

快速入門

本指南需要您深入了解下列 Adobe Experience Platform 元件：

來源： Experience Platform允許從各種來源擷取資料，同時讓您能夠使用Experience Platform服務來建構、加標籤以及增強傳入的資料。
沙箱： Experience Platform提供可將單一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}

您的雲端儲存空間來源聯結器的連線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"
    }
]

使用查詢引數 query

Flow Service API支援使用查詢引數來預覽和檢查不同的檔案型別。

參數

說明

columnDelimiter

您指定為欄分隔字元的單一字元值，以檢查CSV或TSV檔案。如果未提供引數，則值預設為逗號(,)。

compressionType

預覽壓縮的分隔檔案或JSON檔案所需的查詢引數。支援的壓縮檔案包括：

bzip2
gzip
deflate
zipDeflate
tarGzip
tar

encoding

定義呈現預覽時要使用的編碼型別。支援的編碼型別為： UTF-8和ISO-8859-1。注意： encoding引數僅在擷取分隔的CSV檔案時可用。將使用預設編碼UTF-8擷取其他檔案型別。

後續步驟

依照本教學課程，您已探索您的雲端儲存系統、找到您要帶入Experience Platform的檔案路徑，並檢視其結構。您可以在下個教學課程中使用此資訊，從您的雲端儲存空間收集資料，並將其帶入Experience Platform。

recommendation-more-help

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