用户档案系统作业终结点(删除请求)

Adobe Experience Platform使您能够从多个来源收集数据,并为各个客户构建强大的用户档案。 引入Platform的数据存储在Data Lake中,如果已启用用户档案数据集,则该数据也存储在Real-time Customer Profile数据存储中。 有时可能需要从用户档案存储中删除数据集或批处理,以删除不再需要或错误添加的数据。 这需要使用Real-time Customer Profile API创建Profile系统作业或delete request,如果需要,还可以修改、监视或删除该作业。

注意

如果您尝试从Data Lake中删除数据集或批处理,请访问目录服务概述以了解详细信息。

入门指南

本指南中使用的API端点是Real-time Customer Profile API的一部分。 在继续之前,请查阅快速入门指南,了解相关文档的链接、阅读此文档中示例API调用的指南以及成功调用任何Experience PlatformAPI所需标头的重要信息。

视图删除请求

删除请求是一个长时间运行的异步进程,这意味着您的组织可能同时运行多个删除请求。 为了视图您的单位当前正在运行的所有删除请求,您可以对/system/jobs端点执行GET请求。

您还可以使用可选的查询参数来筛选响应中返回的删除请求的列表。 要使用多个参数,请使用和号(&)分隔每个参数。

API格式

GET /system/jobs
GET /system/jobs?{QUERY_PARAMETERS}
参数 描述
start 根据请求的创建时间,偏移返回的结果页。 示例: start=4
limit 限制返回的结果数。 示例: limit=10
page 按照请求的创建时间返回特定的结果页面。 示例: page=2
sort 按特定字段按升序(asc)或降序(desc)顺序对结果排序。 返回多页结果时,sort参数不起作用。 示例: sort=batchId:asc

请求

curl -X GET \
  https://platform.adobe.io/data/core/ups/system/jobs \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

响应

响应包括一个“子项”数组,每个删除请求都有一个对象,其中包含该请求的详细信息。

{
  "_page": {
    "count": 100,
    "next": "K1JJRDpFaWc5QUwyZFgtMEpBQUFBQUFBQUFBPT0jUlQ6MSNUUkM6MiNGUEM6QWdFQUFBQVFBQWZBQUg0Ly9yL25PcmpmZndEZUR3QT0="
  },
  "children": [
    {
      "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
      "imsOrgId": "{IMS_ORG}",
      "batchId": "8d075b5a178e48389126b9289dcfd0ac",
      "jobType": "DELETE",
      "status": "COMPLETED",
      "metrics": "{\"recordsProcessed\":5,\"timeTakenInSec\":1}",
      "createEpoch": 1559026134,
      "updateEpoch": 1559026137
    },
    {
      "id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
      "imsOrgId": "{IMS_ORG}",
      "dataSetId": "5c802d3cd83fc114b741c4b5",
      "jobType": "DELETE",
      "status": "PROCESSING",
      "metrics": "{\"recordsProcessed\":0,\"timeTakenInSec\":15}",
      "createEpoch": 1559025404,
      "updateEpoch": 1559025406
    }
  ]
}
属性 描述
_page.count 请求总数。 此响应已截断空间。
_page.next 如果存在另一页结果,则通过将查找请求中的ID值替换为提供的"next"值来视图下一页结果。
jobType 要创建的作业的类型。 在这种情况下,它将始终返回"DELETE"
status 删除请求的状态。 可能的值为"NEW""PROCESSING""COMPLETED""ERROR"
metrics 一个对象,包括已处理的记录数("recordsProcessed")和请求已处理的时间(以秒为单位),或请求完成所用的时间("timeTakenInSec")。

创建删除请求

通过向/systems/jobs端点发出POST请求来启动新的删除请求,其中,要删除的数据集或批的ID在请求正文中提供。

删除数据集

要从用户档案存储中删除数据集,POST请求的正文中必须包含数据集ID。 此操作将删除给定数据集的所有数据。 Experience Platform 允许您根据记录和时间序列模式删除数据集。

API格式

POST /system/jobs

请求

curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "dataSetId": "5c802d3cd83fc114b741c4b5"
      }'
属性 描述
dataSetId (必需) 要删除的数据集的ID。

响应

成功的响应返回新创建的删除请求的详细信息,包括该请求的唯一、由系统生成的只读ID。 这可用于查找请求并检查其状态。 创建时请求的status"NEW",直到开始处理。 响应中的dataSetId应与请求中发送的dataSetId匹配。

{
    "id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
    "imsOrgId": "{IMS_ORG}",
    "dataSetId": "5c802d3cd83fc114b741c4b5",
    "jobType": "DELETE",
    "status": "NEW",
    "createEpoch": 1559025404,
    "updateEpoch": 1559025406
}
属性 描述
id 删除请求的唯一、系统生成的只读ID。
dataSetId 数据集的ID,在POST请求中指定。

删除批

要删除批,批ID必须包含在POST请求的正文中。 请注意,您不能根据记录模式删除数据集的批次。 只能删除基于时间序列模式的数据集的批次。

注意

无法根据记录模式删除数据集批的原因是记录类型数据集批覆盖了以前的记录,因此无法“撤消”或删除。 要消除基于记录模式的数据集错误批次的影响,唯一的方法是使用正确的数据重新收录批次,以覆盖错误的记录。

有关记录和时间序列行为的详细信息,请查看XDM System概述中有关XDM数据行为🔗的部分。

API格式

POST /system/jobs

请求

curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
       "batchId": "8d075b5a178e48389126b9289dcfd0ac"
      }'
属性 描述
batchId (必需) 要删除的批的ID。

响应

成功的响应返回新创建的删除请求的详细信息,包括该请求的唯一、由系统生成的只读ID。 这可用于查找请求并检查其状态。 创建时请求的"status""NEW",直到开始处理。 响应中的"batchId"值应与请求中发送的"batchId"值匹配。

{
    "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "imsOrgId": "{IMS_ORG}",
    "batchId": "8d075b5a178e48389126b9289dcfd0ac",
    "jobType": "DELETE",
    "status": "NEW",
    "createEpoch": 1559026131,
    "updateEpoch": 1559026132
}
属性 描述
id 删除请求的唯一、系统生成的只读ID。
batchId 批的ID,在POST请求中指定。

如果尝试为“记录”数据集批启动删除请求,您将遇到400级错误,如下所示:

{
    "requestId": "bc4eb29f-63a8-4653-9133-71238884bb81",
    "errors": {
        "400": [
            {
                "code": "500",
                "message": "Batch can only be specified for EE type 'a294e36d382649dab2cc6ad64a41b674'"
            }
        ]
    }
}

视图特定的删除请求

要视图特定的删除请求,包括详细信息(如其状态),可以对/system/jobs端点执行查找(GET)请求,并在路径中包含删除请求的ID。

API格式

GET /system/jobs/{DELETE_REQUEST_ID}
参数 描述
{DELETE_REQUEST_ID} (必需) 要视图的删除请求的ID。

请求

curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs/9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

响应

响应提供删除请求的详细信息,包括其更新状态。 响应中删除请求的ID("id"值)应与请求路径中发送的ID匹配。

{
    "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "imsOrgId": "{IMS_ORG}",
    "batchId": "8d075b5a178e48389126b9289dcfd0ac",
    "jobType": "DELETE",
    "status": "COMPLETED",
    "metrics": "{\"recordsProcessed\":5,\"timeTakenInSec\":1}",
    "createEpoch": 1559026134,
    "updateEpoch": 1559026137
}
属性 描述
jobType 要创建的作业的类型,在这种情况下,它将始终返回"DELETE"
status 删除请求的状态。 可能的值:"NEW""PROCESSING""COMPLETED""ERROR"
metrics 一个数组,包括已处理的记录数("recordsProcessed")和请求已处理的时间(以秒为单位),或请求完成所用的时间("timeTakenInSec")。

删除请求状态为"COMPLETED"后,您可以通过尝试使用数据访问API访问已删除的数据来确认已删除数据。 有关如何使用Data Access API访问数据集和批处理的说明,请查阅数据访问文档

删除请求

Experience Platform 允许您删除以前的请求,这可能由于许多原因(包括删除作业未完成或在处理阶段卡住)而有用。为了删除删除请求,您可以对/system/jobs端点执行DELETE请求,并包括要删除到请求路径的删除请求的ID。

API格式

DELETE /system/jobs/{DELETE_REQUEST_ID}
参数 描述
要删除的删除请求的ID。

请求

curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs/9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

响应

成功的删除请求返回HTTP状态200(OK)和空的响应体。 您可以通过执行GET请求来按删除请求的ID视图删除请求,以确认该请求已被删除。 这应返回HTTP状态404(未找到),指示删除请求已被删除。

后续步骤

现在,您已了解从Experience Platform中的Profile Store删除数据集和批处理时所涉及的步骤,因此可以安全地删除错误添加的数据或组织不再需要的数据。 请注意,删除请求无法撤消,因此您应仅删除您确信现在不需要且将来不需要的数据。

在此页面上