Data Access API指南

数据访问API通过为用户提供一个RESTful接口来支持Adobe Experience Platform ，该接口重点关注Experience Platform内摄取的数据集的可发现性和可访问性。

API规范参考

Swagger API引用文档可在此处找到。

术语

本文档中一些常用术语的描述。

检索批中的文件列表

通过使用批处理标识符(batchID)，数据访问API可以检索属于该特定批处理的文件列表。

API格式

GET /batches/{BATCH_ID}/files

请求

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"数组包含指定批处理中所有文件的列表。 返回的每个文件都有其自己唯一的ID({FILE_ID})，它包含在"dataSetFileId"字段中。 然后，可以使用此唯一ID访问或下载文件。

批量访问和下载文件

通过使用文件标识符({FILE_ID})，数据访问API可用于访问文件的特定详细信息，包括其名称、大小（以字节为单位）以及要下载的链接。

响应将包含一个数据数组。 根据ID所指向的文件是单个文件还是目录，返回的数据数组可能包含一个条目或属于该目录的文件列表。 每个文件元素都将包含文件的详细信息。

API格式

GET /files/{FILE_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": [
    {
      "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 Access API还可用于访问文件的内容。 然后，可以使用此插件将内容下载到外部源。

API格式

GET /files/{dataSetFileId}?path={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}'

响应

Contents of the file

其他代码示例

有关其他示例，请参阅数据访问教程。

订阅数据摄取事件

Platform 可通过Adobe开发人员控制台 提供特定的高价值事件供订阅。例如，您可以订阅数据摄取事件，以接收有关潜在延迟和失败的通知。 有关更多信息，请参阅订阅数据摄取通知的教程。