数据卫生API指南

上次更新: 2023-10-06
  • 创建对象:
  • Developer
    User
    Admin
    Leader

数据卫生API允许您以编程方式更正或删除客户在Adobe Experience Platform中存储的个人数据,以及安排数据集的到期日期。 本指南介绍了使用API的先决步骤,并提供了指向更多特定于端点的文档的链接。

快速入门

您可以通过以下根路径访问数据卫生API: https://platform.adobe.io/data/core/hygiene/

以下各节概述了您在尝试调用API之前需要了解的核心概念。

收集所需标头的值

要调用数据卫生API,您必须首先收集身份验证凭据。 请遵循 API身份验证指南 为数据卫生API的每个所需标头生成值,如下所示:

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

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

  • Content-Type: application/json

正在读取示例 API 调用

本文档提供了一个示例API调用,用于演示如何格式化请求。 有关文档中用于示例API调用的惯例的信息,请参阅 如何读取示例API调用 《Experience PlatformAPI快速入门指南》中的。

数据集过期时间

数据集到期是一种时间延迟的“删除数据集”操作。 通过创建数据集过期,您可以指定在未来的某个时间删除该数据集。 请参阅 数据集到期端点指南 有关在API中计划数据集过期的详细信息。

记录删除

重要

记录删除请求仅适用于已购买的组织 AdobeHealth Shield.

记录删除旨在用于数据清理、匿名数据删除或数据最小化。 他们是 用于数据主体权利请求(符合),与通用数据保护条例(GDPR)等隐私法规相关。 对于所有合规性用例,使用 Adobe Experience Platform Privacy Service 而是。

数据卫生API允许您在一个或所有数据集中删除与某个身份关联的所有记录。 所有删除身份的数据生命周期任务均由称为工作单的构造表示。 请参阅 工单终结点指南 以了解有关在API中使用记录删除的详细信息。

配额

您的组织受限于每个类型的数据生命周期操作的预定每月任务配额,该配额可能因许可而有所不同。 请参阅 配额终结点指南 以了解有关查看数据生命周期进程的当前配额状态的详细信息。

后续步骤

本指南介绍了如何使用API调用管理数据生命周期请求。 有关如何在Platform UI中执行这些操作的信息,请参阅 数据生命周期用户界面指南.

在此页面上