Show Menu
主題×

資料存取開發人員指南

Data Access API為使用者提供REST風格的介面,以協助使用者在Adobe Experience Platform中找到所擷取的資料集並存取資料集 Experience Platform。

API規格參考

Swagger API參考檔案可在這裡 找到

術語

本檔案中常用術語的說明。
詞語
說明
資料集
包含架構和欄位的資料集合。
批次
一組在一段時間內收集並以單個單位一起處理的資料。

檢索批中的檔案清單

透過使用批次識別碼(batchID),資料存取API可擷取屬於該特定批次的檔案清單。
API格式
GET /batches/{BATCH_ID}/files

屬性
說明
{BATCH_ID}
指定批的ID。
請求
curl -X GET https://platform.adobe.io/data/foundation/export/batches/{BATCH_ID}/files \
  -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}'

回應
{
  "data": [
    {
      "dataSetFileId": "{FILE_ID_1}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_1}"
        }
      }
    },
    {
      "dataSetFileId": "{FILE_ID_2}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_2}"
        }
      }
    },
  ],
  "_page": {
    "limit": 100,
    "count": 1
  }
}

"data" 列包含指定批中所有檔案的清單。 傳回的每個檔案在欄位中都包含其 {FILE_ID} 專屬的唯一ID( "dataSetFileId" )。 然後,此唯一ID可用來存取或下載檔案。
屬性
說明
data.dataSetFileId
指定批次中每個檔案的檔案ID。
data._links.self.href
存取檔案的URL。

在批次中存取和下載檔案

透過使用檔案識別碼( {FILE_ID} ),資料存取API可用來存取檔案的特定詳細資訊,包括檔案名稱、檔案大小(以位元組為單位)以及下載連結。
回應將包含資料陣列。 根據ID所指向的檔案是單個檔案還是目錄,返回的資料陣列可能包含屬於該目錄的單個條目或檔案清單。 每個檔案元素都會包含檔案的詳細資訊。
API格式
GET /files/{FILE_ID}

屬性
說明
{FILE_ID}
等於 "dataSetFileId" ,即要訪問的檔案的ID。
請求
curl -X GET https://platform.adobe.io/data/foundation/export/files/{FILE_ID} \
  -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}'

單一檔案回應
{
  "data": [
    {
      "name": "{FILE_NAME}",
      "length": "{LENGTH}",
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID}?path={FILE_NAME}"
        }
      }
    }
  ],
  "_page": {
    "limit": 100,
    "count": 1
  }
}

屬性
說明
data.name
檔案的名稱(例如profiles.csv)。
data.length
檔案大小(以位元組為單位)。
data._links.self.href
下載檔案的URL。
目錄響應
{
  "data": [
    {
      "dataSetFileId": "{FILE_ID_1}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_1}"
        }
      }
    },
    {
      "dataSetFileId": "{FILE_ID_2}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_2}"
        }
      }
    }
  ],
  "_page": {
    "limit": 100,
    "count": 2
  }
}

返回目錄時,該目錄包含目錄內所有檔案的陣列。
屬性
說明
data.name
檔案的名稱(例如profiles.csv)。
data._links.self.href
下載檔案的URL。

存取檔案內容

此 Data Access API也可用來存取檔案的內容。 然後,這可用來將內容下載至外部來源。
API格式
GET /files/{dataSetFileId}?path={FILE_NAME}

屬性
說明
{FILE_NAME}
您嘗試存取的檔案名稱。
請求
curl -X GET https://platform.adobe.io/data/foundation/export/files/{FILE_ID}?path={FILE_NAME} \
  -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}'

屬性
說明
{FILE_ID}
資料集內檔案的ID。
{FILE_NAME}
檔案的完整名稱(例如profiles.csv)。
回應
Contents of the file

其他程式碼範例

如需其他範例,請參閱資料 存取教學課程

訂閱資料擷取事件

平台可透過 Adobe Developer Console提供特定的高價值活動供訂閱 。 例如,您可以訂閱資料擷取事件,以通知您可能發生的延遲和失敗。 如需詳細資訊,請 參閱訂閱資料擷取通知 的教學課程。