Data Access API指南

数据访问API通过为用户提供一个RESTful界面来支持Adobe Experience Platform ,该界面重点关注内摄取数据集的可发现性和可访问性 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: {ORG_ID}' \
  -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" 数组包含指定批处理中所有文件的列表。 返回的每个文件都有其自己的唯一ID({FILE_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: {ORG_ID}' \
  -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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'
属性 描述
{FILE_ID} 数据集中文件的ID。
{FILE_NAME} 文件的全名(例如profiles.csv)。

响应

Contents of the file

其他代码示例

有关其他示例,请参阅 数据访问教程.

订阅数据摄取事件

Platform 通过 Adobe开发人员控制台. 例如,您可以订阅数据摄取事件,以接收有关潜在延迟和失败的通知。 请参阅 订阅数据摄取通知 以了解更多信息。

在此页面上