使用Flow Service API探索資料庫

此教學課程使用Flow Service API來探索協力廠商資料庫的內容和檔案結構。

快速入門

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

下列章節提供您需瞭解的其他資訊，才能使用Flow Service API成功連線至協力廠商資料庫。

收集必要的認證

本教學課程需要您與要擷取資料的第三方資料庫建立有效的連線。 有效的連線涉及資料庫的連線規格ID和連線ID。 有關建立資料庫連線及擷取這些值的詳細資訊，請參閱來源聯結器概觀。

讀取範例 API 呼叫

本教學課程提供範例API呼叫，示範如何格式化您的請求。 這些包括路徑、必要的標頭和正確格式化的請求承載。 此外，也提供 API 回應中傳回的範例 JSON。 如需檔案中所使用範例API呼叫慣例的詳細資訊，請參閱Experience Platform疑難排解指南中如何讀取範例API呼叫一節。

收集所需標頭的值

若要呼叫Platform API，您必須先完成驗證教學課程。 完成驗證教學課程後，將會提供所有Experience Platform API呼叫中每個必要標頭的值，如下所示：

Experience Platform中的所有資源（包括屬於Flow Service的資源）都與特定的虛擬沙箱隔離。 對Platform API的所有請求都需要標頭，以指定將在其中執行作業的沙箱名稱：

包含裝載(POST、PUT、PATCH)的所有請求都需要額外的媒體型別標頭：

探索您的資料表

使用資料庫的連線ID，您可以透過執行GET請求來探索資料表。 使用以下呼叫來尋找您要檢查或擷取至Platform的資料表的路徑。

API格式

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root

要求

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/explore?objectType=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}'

回應

成功的回應會從資料庫傳回資料表陣列。 尋找您要帶入Platform的資料表並記下其path屬性，因為您必須在下個步驟中提供它以檢查其結構。

[
    {
        "type": "table",
        "name": "test1.Mytable",
        "path": "test1.Mytable",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "test1.austin_demo",
        "path": "test1.austin_demo",
        "canPreview": true,
        "canFetchSchema": true
    }
]

Inspect表格的結構

若要從資料庫檢查資料表的結構，請在將資料表的路徑指定為查詢引數時執行GET要求。

API格式

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}

要求

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/explore?objectType=table&object=test1.Mytable' \
    -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}'

回應

成功的回應會傳回指定資料表的結構。 有關每個資料表資料行的詳細資料位於columns陣列的元素中。

{
    "format": "flat",
    "schema": {
        "columns": [
            {
                "name": "TestID",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Name",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            }
        ]
    }
}

後續步驟

依照本教學課程，您已探索您的資料庫、找到您要擷取至Platform的表格路徑，並取得有關其結構的資訊。 您可以在下一個教學課程中使用此資訊，從資料庫收集資料並將其帶入Platform。