批量摄取概述

Adobe Experience Platform Data Ingestion API允许您将数据作为批处理文件引入平台。 所摄取的用户档案可以是来自CRM系统中的平面文件(如Parke文件)的模式数据,或符合Experience Data Model (XDM)注册表中的已知数据的数据。

数据摄取API参考提供了有关这些API调用的其他信息。

下图概述了批摄取过程:

使用API

Data Ingestion API允许您通过以下三个基本步骤将数据作为批量(由一个或多个要作为单个单元摄取的文件组成的数据单元)收录到Experience Platform中:

  1. 创建新批。
  2. 将文件上传到与数据的XDM模式匹配的指定数据集。
  3. 发出批次结束的信号。

Data Ingestion 先决条件

  • 要上载的数据必须采用Parke或JSON格式。
  • Catalog services中创建的数据集。
  • Parce文件的内容必须与要上载到的数据集的模式子集匹配。
  • 验证后获得您的唯一访问令牌。

批量摄取最佳实践

  • 建议的批处理大小介于256 MB和100 GB之间。
  • 每个批应最多包含1500个文件。

要上传大于512MB的文件,需要将文件分为较小的块。 在此处可找到上载大文件的说明。

读取示例API调用

本指南提供示例API调用,以演示如何设置请求的格式。 这包括路径、必需的标头和格式正确的请求负载。 还提供API响应中返回的示例JSON。 有关示例API调用文档中使用的约定的信息,请参阅Experience Platform疑难解答指南中关于如何读取示例API调用🔗的部分。

收集所需标题的值

要调用Platform API,您必须首先完成身份验证教程。 完成身份验证教程后,将为所有Experience Platform API调用中每个所需标头提供值,如下所示:

  • 授权:承载{ACCESS_TOKEN}
  • x-api-key:{API_KEY}
  • x-gw-ims-org-id:{IMS_ORG}

Experience Platform中的所有资源都隔离到特定虚拟沙箱。 对Platform API的所有请求都需要一个头,该头指定操作将在中执行的沙箱的名称:

  • x-sandbox-name:{SANDBOX_NAME}
注意

有关Platform中沙箱的详细信息,请参阅沙箱概述文档

所有包含有效负荷(POST、PUT、PATCH)的请求都需要额外的标头:

  • 内容类型:application/json

创建批

在将数据添加到数据集之前,必须将其链接到批处理,随后该批处理将上载到指定的数据集。

POST /batches

请求

curl -X POST "https://platform.adobe.io/data/foundation/import/batches" \
  -H "Content-Type: application/json" \
  -H "x-gw-ims-org-id: {IMS_ORG}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key : {API_KEY}"
  -d '{ 
          "datasetId": "{DATASET_ID}" 
      }'
属性 描述
datasetId 要将文件上载到的数据集的ID。

雷庞塞

{
    "id": "{BATCH_ID}",
    "imsOrg": "{IMS_ORG}",
    "updated": 0,
    "status": "loading",
    "created": 0,
    "relatedObjects": [
        {
            "type": "dataSet",
            "id": "{DATASET_ID}"
        }
    ],
    "version": "1.0.0",
    "tags": {},
    "createdUser": "{USER_ID}",
    "updatedUser": "{USER_ID}"
}
属性 描述
id 刚创建的批的ID(用于后续请求)。
relatedObjects.id 要将文件上载到的数据集的ID。

文件上传

成功创建新批以上载后,文件即可上载到特定数据集。

您可以使用“小文件上传API”上传文件。 但是,如果您的文件太大而超出网关限制(如延长超时、超出正文大小的请求和其他限制),则可以切换到“大文件上传API”。 此API以块为单位上传文件,并使用“大文件上传完整API”调用将数据拼接在一起。

注意

以下示例使用Apache Parmeca文件格式。 可在批处理开发人员指南中找到使用JSON文件格式的示例。

小文件上传

创建批后,数据即可上传到预先存在的数据集。 要上传的文件必须与其引用的XDM模式匹配。

PUT /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
属性 描述
{BATCH_ID} 批的ID。
{DATASET_ID} 要上载文件的数据集的ID。
{FILE_NAME} 在数据集中看到的文件名称。

请求

curl -X PUT "https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.parquet" \
  -H "content-type: application/octet-stream" \
  -H "x-gw-ims-org-id: {IMS_ORG}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key : {API_KEY}" \
  --data-binary "@{FILE_PATH_AND_NAME}.parquet"
属性 描述
{FILE_PATH_AND_NAME} 要上载到数据集中的文件的路径和文件名。

雷庞塞

#Status 200 OK, with empty response body

大文件上传 — 创建文件

要上传大文件,必须将文件拆分为较小的块,并一次上载一个。

POST /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}?action=initialize
属性 描述
{BATCH_ID} 批的ID。
{DATASET_ID} 摄取文件的数据集的ID。
{FILE_NAME} 在数据集中看到的文件名称。

请求

curl -X POST "https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/part1=a/part2=b/{FILE_NAME}.parquet?action=initialize" \
  -H "x-gw-ims-org-id: {IMS_ORG}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}"

雷庞塞

#Status 201 CREATED, with empty response body

大文件上传 — 上传后续部分

创建文件后,可以通过重复PATCH请求(针对文件的每个部分发出一个请求)来上载所有后续块。

PATCH /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
属性 描述
{BATCH_ID} 批的ID。
{DATASET_ID} 要将文件上载到的数据集的ID。
{FILE_NAME} 文件在数据集中的显示名称。

请求

curl -X PATCH "https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/part1=a/part2=b/{FILE_NAME}.parquet" \
  -H "content-type: application/octet-stream" \
  -H "x-gw-ims-org-id: {IMS_ORG}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "Content-Range: bytes {CONTENT_RANGE}" \
  --data-binary "@{FILE_PATH_AND_NAME}.parquet"
属性 描述
{FILE_PATH_AND_NAME} 要上载到数据集中的文件的路径和文件名。

雷庞塞

#Status 200 OK, with empty response

信号批处理完成

在所有文件都上载到批后,可以指示批完成。 通过执行此操作,将为已完成的文件创建Catalog DataSetFile条目,并与上面生成的批关联。 然后,Catalog批被标记为成功,这会触发下游流以获取可用数据。

请求

POST /batches/{BATCH_ID}?action=COMPLETE
属性 描述
{BATCH_ID} 要上载到数据集的批的ID。
curl -X POST "https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=COMPLETE" \
-H "x-gw-ims-org-id: {IMS_ORG}" \
-H "x-sandbox-name: {SANDBOX_NAME}" \
-H "Authorization: Bearer {ACCESS_TOKEN}" \
-H "x-api-key : {API_KEY}"

雷庞塞

#Status 200 OK, with empty response

检查批状态

在等待文件上载到批时,可以检查批的状态以查看其进度。

API格式

GET /batch/{BATCH_ID}
属性 描述
{BATCH_ID} 正在检查的批的ID。

请求

curl GET "https://platform.adobe.io/data/foundation/catalog/batch/{BATCH_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-gw-ims-org-id: {IMS_ORG}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "x-api-key: {API_KEY}"

雷庞塞

{
    "{BATCH_ID}": {
        "imsOrg": "{IMS_ORG}",
        "created": 1494349962314,
        "createdClient": "MCDPCatalogService",
        "createdUser": "{USER_ID}",
        "updatedUser": "{USER_ID}",
        "updated": 1494349963467,
        "externalId": "{EXTERNAL_ID}",
        "status": "success",
        "errors": [
            {
                "code": "err-1494349963436"
            }
        ],
        "version": "1.0.3",
        "availableDates": {
            "startDate": 1337,
            "endDate": 4000
        },
        "relatedObjects": [
            {
                "type": "batch",
                "id": "foo_batch"
            },
            {
                "type": "connection",
                "id": "foo_connection"
            },
            {
                "type": "connector",
                "id": "foo_connector"
            },
            {
                "type": "dataSet",
                "id": "foo_dataSet"
            },
            {
                "type": "dataSetView",
                "id": "foo_dataSetView"
            },
            {
                "type": "dataSetFile",
                "id": "foo_dataSetFile"
            },
            {
                "type": "expressionBlock",
                "id": "foo_expressionBlock"
            },
            {
                "type": "service",
                "id": "foo_service"
            },
            {
                "type": "serviceDefinition",
                "id": "foo_serviceDefinition"
            }
        ],
        "metrics": {
            "foo": 1337
        },
        "tags": {
            "foo_bar": [
                "stuff"
            ],
            "bar_foo": [
                "woo",
                "baz"
            ],
            "foo/bar/foo-bar": [
                "weehaw",
                "wee:haw"
            ]
        },
        "inputFormat": {
            "format": "parquet",
            "delimiter": ".",
            "quote": "`",
            "escape": "\\",
            "nullMarker": "",
            "header": "true",
            "charset": "UTF-8"
        }
    }
}
属性 描述
{USER_ID} 创建或更新批的用户的ID。

"status"字段显示所请求批的当前状态。 这些批可以具有以下状态之一:

批摄取状态

状态 描述
已放弃 批未在预期时间范围内完成。
中止 已为指定批调用了​显式​的中止操作(通过批摄取API)。 一旦批处于“已加载”状态,便无法中止它。
活动 批已成功提升,可用于下游冲减。 此状态可与“成功”交替使用。
已删除 批的数据已完全删除。
失败 由错误配置和/或错误数据导致的终端状态。 失败批处理的数据将​不显示。 此状态可与“Failure”(失败)可互换使用。
非活动 批已成功提升,但已还原或已过期。 批不再可用于下游冲减。
已加载 批的数据已完成,批准备好进行升级。
正在加载 正在上载此批的数据,该批当前​​准备提升。
正在重试 正在处理此批的数据。 但是,由于系统或临时错误,批处理失败 — 因此,正在重试此批处理。
已暂存 批处理的升级过程的阶段阶段已完成,并且已运行摄取作业。
暂存 正在处理批的数据。
停止 正在处理批的数据。 但是,批促销已在多次重试后停止。

在此页面上