流式摄取验证
流式摄取允许您使用流式端点实时将数据上传到Adobe Experience Platform。 流式引入API支持两种验证模式 — 同步和异步。
快速入门
本指南要求您对 Adobe Experience Platform 的以下组件有一定了解:
- Experience Data Model (XDM) System: Experience Platform用于组织客户体验数据的标准化框架。
- Streaming Ingestion:将数据发送到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:
{ORG_ID}
Experience Platform中的所有资源(包括属于Schema Registry的资源)都被隔离到特定的虚拟沙盒中。 对Platform API的所有请求都需要一个标头,用于指定将在其中执行操作的沙盒的名称:
- x-sandbox-name:
{SANDBOX_NAME}
包含负载 (POST、PUT、PATCH) 的所有请求都需要额外的标头:
- 内容类型:
application/json
验证范围
Streaming Validation Service包括以下方面的验证:
- Range
- 存在
- 枚举
- 模式
- 类型
- 格式
同步验证
同步验证是一种验证方法,可提供有关摄取失败原因的即时反馈。 但是,失败时,将丢弃验证失败的记录并阻止将其发送到下游。 因此,同步验证只应在开发过程中使用。 在执行同步验证时,会向调用方通知XDM验证的结果,如果验证失败,还会通知失败原因。
默认情况下,同步验证未打开。 要启用此功能,您必须在进行API调用时传入可选的查询参数syncValidation=true
。 此外,当前仅当您的流端点位于VA7数据中心时,同步验证才可用。
syncValidation
查询参数仅适用于单个消息终结点,不能用于批处理终结点。如果消息在同步验证过程中失败,则不会将该消息写入输出队列,这将为用户提供即时反馈。
API格式
POST /collection/{CONNECTION_ID}?syncValidation=true
{CONNECTION_ID}
id
值。请求
提交以下请求,通过同步验证将数据摄取到您的数据入口:
curl -X POST https://dcs.adobedc.net/collection/{CONNECTION_ID}?syncValidation=true \
-H "Content-Type: application/json" \
-d '{JSON_PAYLOAD}'
{JSON_PAYLOAD}
响应
启用同步验证后,成功的响应会在其有效负载中包含任何遇到的验证错误:
{
"type": "http://ns.adobe.com/adobecloud/problem/data-collection-service/inlet",
"status": 400,
"title": "Invalid XDM Message Format",
"report": {
"message": "inletId: [6aca7aa2d87ebd6b2780ca5724d94324a14475f140a2b69373dd5c714430dfd4] imsOrgId: [7BF122A65C5B3FE40A494026@AdobeOrg] Message is invalid",
"cause": {
"_streamingValidation": [
{
"schemaLocation": "#",
"pointerToViolation": "#",
"causingExceptions": [
{
"schemaLocation": "#",
"pointerToViolation": "#",
"causingExceptions": [],
"keyword": "additionalProperties",
"message": "extraneous key [workEmail] is not permitted"
},
{
"schemaLocation": "#",
"pointerToViolation": "#",
"causingExceptions": [],
"keyword": "additionalProperties",
"message": "extraneous key [person] is not permitted"
},
{
"schemaLocation": "#/properties/_id",
"pointerToViolation": "#/_id",
"causingExceptions": [],
"keyword": "type",
"message": "expected type: String, found: Long"
}
],
"message": "3 schema violations found"
}
]
}
}
}
上述响应列出了发现了多少方案违规以及违规内容。 例如,此响应声明未在架构中定义键workEmail
和person
,因此不允许使用。 它还将_id
的值标记为不正确,因为架构需要string
,但插入的是long
。 请注意,一旦遇到五个错误,验证服务将 停止 处理该消息。 但是,将继续解析其他消息。
异步验证
异步验证是一种不会立即提供反馈的验证方法。 而是将数据发送到Data Lake中的失败批次,以防止数据丢失。 可以稍后检索此失败数据以便进一步分析和重放。 此方法应在生产中使用。 除非另有请求,否则流式摄取在异步验证模式下运行。
API格式
POST /collection/{CONNECTION_ID}
{CONNECTION_ID}
id
值。请求
提交以下请求,通过异步验证将数据摄取到您的数据入口:
curl -X POST https://dcs.adobedc.net/collection/{CONNECTION_ID} \
-H "Content-Type: application/json" \
-d '{JSON_PAYLOAD}'
{JSON_PAYLOAD}
响应
启用异步验证后,成功的响应将返回以下内容:
{
"inletId": "f6ca9706d61de3b78be69e2673ad68ab9fb2cece0c1e1afc071718a0033e6877",
"xactionId": "1555445493896:8600:8",
"receivedTimeMs": 1555445493932,
"syncValidation": {
"skipped": true
}
}
请注意,响应中指出已跳过同步验证,因为未明确请求该响应。
附录
本节包含有关各种状态代码对摄取数据的响应有何含义的信息。