Adobe Experience Platform提供两种上传和摄取数据的方法。 您可以使用批量摄取,这允许您使用各种文件类型(如CSV)插入其数据;也可以使用流式摄取,这允许您将其数据插入到 Platform 实时使用流式端点。
本教程介绍了使用检索有关失败批次信息的步骤 Data Ingestion API。
本指南要求您对Adobe Experience Platform的以下组件有一定的了解:
本教程提供了示例API调用来演示如何设置请求的格式。 这些资源包括路径、必需的标头和格式正确的请求负载。 此外,还提供了在API响应中返回的示例JSON。 有关示例API调用文档中使用的约定的信息,请参阅以下章节: 如何读取示例API调用 在 Experience Platform 疑难解答指南。
为了调用 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}
有关中沙箱的详细信息 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格式不正确造成的。 根据问题的性质,这些错误消息会有所不同。 因此,无法显示具体的错误示例。
如果有效负载中缺少组织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"
}
}
在以下情况下显示此错误: schemaRef
对于 xdmMeta
缺失。
{
"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"
}
]
}
}
如果没有,则显示此错误 xdmEntity
存在。
{
"_validationErrors": [
{
"message": "Payload body is missing xdmEntity"
}
]
}