Show Menu
主題×

使用Flow Service API探索雲端儲存系統

Flow Service用於收集和集中Adobe Experience Platform內不同來源的客戶資料。 該服務提供用戶介面和REST風格的API,所有支援的源都可從中連接。
本教學課程使用Flow Service API來探索協力廠商雲端儲存系統。

快速入門

本指南需要有效瞭解Adobe Experience Platform的下列元件:
  • 來源 :Experience Platform可讓您從各種來源擷取資料,同時讓您能夠使用平台服務來建構、標示和增強傳入資料。
  • 沙盒 :Experience Platform提供虛擬沙盒,可將單一Platform實例分割為不同的虛擬環境,以協助開發和發展數位體驗應用程式。
以下各節提供您必須知道的其他資訊,以便使用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中的所有資源(包括屬於Flow Service的資源)都隔離至特定的虛擬沙盒。 所有對平台API的請求都需要一個標題,該標題會指定要在中執行的操作的沙盒名稱:
  • x-sandbox-name: {SANDBOX_NAME}
所有包含裝載(POST、PUT、PATCH)的請求都需要額外的媒體類型標題:
  • 內容類型: 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規範
  • PARCE:阿帕奇鑲木地板。 拼花檔案必須與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"
    }
]

後續步驟

通過本教程,您已探索了雲儲存系統,找到了要導入平台的檔案路徑,並查看了其結構。 您可以在下一個教學課程中使用此資 訊,從雲端儲存空間收集資料並匯入平台