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

Adobe Experience Platform提供两种上传和收录数据的方法。 您可以使用批处理摄取,它允许您使用各种文件类型(如CSV)插入其数据;或者使用流摄取,它允许您使用流端点将其数据实时插入到Platform。

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

入门指南

本指南要求对Adobe Experience Platform的以下组件有充分的了解:

读取示例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中的所有资源(包括属于Schema Registry的资源)都隔离到特定虚拟沙箱。 对Platform API的所有请求都需要一个头,该头指定操作将在中执行的沙箱的名称:

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

有关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: {IMS_ORG}" \
  -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: {IMS_ORG}' \
  -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造成的。 根据问题的性质,这些错误消息会有所不同。 因此,不能显示任何特定的错误示例。

缺少或无效的IMS组织ID

如果有效负荷中缺少IMS组织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: [{IMS_ORG}@AdobeOrg] Message has an absent or wrong ims org in the header"
    }
}

缺少XDM模式

如果xdmMetaschemaRef缺失,则显示此错误。

{
    "type": "http://ns.adobe.com/adobecloud/problem/data-collection-service/inlet",
    "status": 400,
    "title": "Invalid XDM Message Format",
    "report": {
        "message": "inletId: [{INLET_ID}] imsOrgId: [{IMS_ORG}@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"
        }
    ]
}

在此页面上