文档 Experience Platform Data Ingestion 指南

使用数据访问API检索失败的批次

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：
数据摄入

创建对象：

开发人员

Adobe Experience Platform提供两种上传和摄取数据的方法。您可以使用批量摄取，这允许您使用各种文件类型（如CSV）插入其数据；也可以使用流式摄取，这允许您使用流式端点实时将其数据插入到Platform。

本教程介绍使用Data Ingestion API检索有关失败批次信息的步骤。

快速入门

本指南要求您对 Adobe Experience Platform 的以下组件有一定了解：

Experience Data Model (XDM) System： Experience Platform用于组织客户体验数据的标准化框架。
Data Ingestion：将数据发送到Experience Platform的方法。

正在读取示例 API 调用

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

收集所需标头的值

要调用Platform API，您必须先完成身份验证教程。完成身份验证教程会提供所有 Experience Platform API 调用中每个所需标头的值，如下所示：

Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {ORG_ID}

Experience Platform中的所有资源（包括属于Schema Registry的资源）都被隔离到特定的虚拟沙盒中。对Platform API的所有请求都需要一个标头，用于指定将在其中执行操作的沙盒的名称：

x-sandbox-name: {SANDBOX_NAME}

NOTE

有关Platform中沙盒的更多信息，请参阅沙盒概述文档。

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

Content-Type: application/json

失败的批次示例

本教程将使用具有错误格式时间戳的示例数据，该时间戳将月值设置为 00，如下所示：

{
    "body": {
        "xdmEntity": {
            "id": "c8d11988-6b56-4571-a123-b6ce74236036",
            "timestamp": "2018-00-10T22:07:56Z",
            "environment": {
                "browserDetails": {
                    "userAgent": "Mozilla\/5.0 (Windows NT 5.1) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/29.0.1547.57 Safari\/537.36 OPR\/16.0.1196.62",
                    "acceptLanguage": "en-US",
                    "cookiesEnabled": true,
                    "javaScriptVersion": "1.6",
                    "javaEnabled": true
                },
                "colorDepth": 32,
                "viewportHeight": 799,
                "viewportWidth": 414
            }
        }
    }
}

由于时间戳的格式不正确，无法针对XDM架构正确验证上述有效负载。

检索失败的批次

API格式

GET /batches/{BATCH_ID}/failed

属性

描述

{BATCH_ID}

要查找的批次的ID。

请求

curl -X GET 'https://platform.adobe.io/data/foundation/export/batches/{BATCH_ID}/failed' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

响应

{
    "data": [
        {
            "name": "_SUCCESS",
            "length": "0",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io:443/data/foundation/export/batches/{BATCH_ID}/failed?path=_SUCCESS"
                }
            }
        },
        {
            "name": "part-00000-44c7b669-5e38-43fb-b56c-a0686dabb982-c000.json",
            "length": "1800",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io:443/data/foundation/export/batches/{BATCH_ID}/failed?path=part-00000-44c7b669-5e38-43fb-b56c-a0686dabb982-c000.json"
                }
            }
        }
    ],
    "_page": {
        "limit": 100,
        "count": 2
    }
}

通过上述响应，您可以查看批次的哪些块成功和失败。通过此响应，您可以看到文件part-00000-44c7b669-5e38-43fb-b56c-a0686dabb982-c000.json包含失败的批次。

下载失败的批次

知道批次中的哪个文件失败后，即可下载失败的文件并查看错误消息。

API格式

GET /batches/{BATCH_ID}/failed?path={FAILED_FILE}

属性

描述

{BATCH_ID}

包含失败文件的批次的ID。

{FAILED_FILE}

格式设置失败的文件名。

请求

以下请求允许您下载包含摄取错误的文件。

curl -X GET 'https://platform.adobe.io/data/foundation/export/batches/{BATCH_ID}/failed?path={FAILED_FILE}' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

响应

由于上一个摄取的批次具有无效的日期时间，因此将显示以下验证错误。

{
    "_validationErrors": [
        {
            "causingExceptions": [],
            "keyword": "format",
            "message": "[2018-00-23T22:07:01Z] is not a valid date-time. Expected [yyyy-MM-dd'T'HH:mm:ssZ, yyyy-MM-dd'T'HH:mm:ss.[0-9]{1-9}Z, yyyy-MM-dd'T'HH:mm:ss[+-]HH:mm, yyyy-MM-dd'T'HH:mm:ss.[0-9]{1,9}[+-]HH:mm]",
            "pointerToViolation": "#/timestamp",
            "schemaLocation": "#/properties/timestamp"
        }
    ]
}

后续步骤

阅读本教程后，您已了解如何从失败的批次中检索错误。有关批量摄取的更多信息，请阅读批量摄取开发人员指南。有关流式摄取的更多信息，请参阅创建流式连接教程。

附录

此部分包含有关可能发生的其他摄取错误类型的信息。

XDM格式不正确

与上一个示例流中的时间戳错误一样，这些错误是由于XDM格式不正确造成的。根据问题的性质，这些错误消息会有所不同。因此，无法显示具体的错误示例。

组织ID缺失或无效

如果有效负载中缺少组织ID无效，则会显示此错误。

{
    "type": "http://ns.adobe.com/adobecloud/problem/data-collection-service/inlet",
    "status": 400,
    "title": "Invalid XDM Message Format",
    "report": {
        "message": "inletId: [{INLET_ID}] imsOrgId: [{ORG_ID}@AdobeOrg] Message has an absent or wrong ims org in the header"
    }
}

缺少XDM架构

如果缺少xdmMeta的schemaRef，则显示此错误。

{
    "type": "http://ns.adobe.com/adobecloud/problem/data-collection-service/inlet",
    "status": 400,
    "title": "Invalid XDM Message Format",
    "report": {
        "message": "inletId: [{INLET_ID}] imsOrgId: [{ORG_ID}@AdobeOrg] Message has unknown xdm format"
    }
}

缺少源名称

如果标头中的source缺少其name，则会显示此错误。

{
    "_errors":{
        "_streamingValidation": [
            {
                "message": "Payload header is missing Source Name"
            }
        ]
    }
}

缺少XDM实体

如果没有xdmEntity，则显示此错误。

{
    "_validationErrors": [
        {
            "message": "Payload body is missing xdmEntity"
        }
    ]
}

recommendation-more-help

2ee14710-6ba4-4feb-9f79-0aad73102a9a