Show Menu
主题×

隐私工作

本文档介绍如何使用API调用处理隐私作业。 具体而言,它涵盖API中 /job 端点的使 Privacy Service 用。 在阅读本指南之前,请参 阅入门部分 ,了解成功调用API所需的重要信息,包括必需的头以及如何读取示例API调用。
如果您试图管理客户的同意或退出请求,请参阅同意终 点指南

列表所有作业

您可以通过向端点发出视图请求,列表组织内所有可用隐私作业的GET /jobs 符。
API格式
此请求格式在端 regulation 点上使用查询 /jobs 参数,因此它以问号()开 ? 头,如下所示。 对响应进行分页,以便您使用其他查询参数( page size )筛选响应。 您可以使用和号()分隔多个 & 参数。
GET /jobs?regulation={REGULATION}
GET /jobs?regulation={REGULATION}&page={PAGE}
GET /jobs?regulation={REGULATION}&size={SIZE}
GET /jobs?regulation={REGULATION}&page={PAGE}&size={SIZE}

参数
描述
{REGULATION}
查询的调节类型。 接受的 gdpr ccpa 有、 lgpd_bra pdpa_tha
{PAGE}
要显示的数据页,使用基于0的编号。 默认值为 0
{SIZE}
每页上显示的结果数。 默认值为, 1 最大值为 100 。 超过最大值将导致API返回400代码错误。
请求
以下请求从页面大小为50的第三页开始检索IMS组织内所有作业的分页列表。
curl -X GET \
  https://platform.adobe.io/data/core/privacy/jobs?regulation=gdpr&page=2&size=50 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}'

响应
成功的响应会返回一列表作业,每个作业都包含详细信息(如 jobId 。 在此示例中,响应将包含50个作业的列表,从结果的第三页开始。

访问后续页面

要在分页响应中获取下一组结果,您必须对同一端点进行另一个API调用,同时将查询参数 page 增加1。

创建隐私工作

在创建新作业请求之前,您必须先收集有关要访问、删除或销售其数据的数据主体选择退出的标识信息。 获得所需数据后,必须在POST请求到端点的有效负荷中提供该 /jobs 数据。
兼容的Adobe Experience Cloud应用程序使用不同的值来识别数据主体。 有关应用程序 所需标识符的更 多信息,请参阅Privacy Service和Experience Cloud应用程序指南。 有关确定要发送哪些ID的更一般指 Privacy Service南,请参阅隐私 请求中的身份文档
API Privacy Service 支持两种对个人数据的作业请求:
虽然访问和删除请求可以合并为单个API调用,但是必须单独发出退出请求。

创建访问/删除作业

本节演示如何使用API发出访问/删除作业请求。
API格式
POST /jobs

请求
以下请求将创建新作业请求,该请求由有效负荷中提供的属性进行配置,如下所述。
curl -X POST \
  https://platform.adobe.io/data/core/privacy/jobs \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -d '{
    "companyContexts": [
      {
        "namespace": "imsOrgID",
        "value": "{IMS_ORG}"
      }
    ],
    "users": [
      {
        "key": "DavidSmith",
        "action": ["access"],
        "userIDs": [
          {
            "namespace": "email",
            "value": "dsmith@acme.com",
            "type": "standard"
          },
          {
            "namespace": "ECID",
            "type": "standard",
            "value":  "443636576799758681021090721276",
            "isDeletedClientSide": false
          }
        ]
      },
      {
        "key": "user12345",
        "action": ["access","delete"],
        "userIDs": [
          {
            "namespace": "email",
            "value": "ajones@acme.com",
            "type": "standard"
          },
          {
            "namespace": "loyaltyAccount",
            "value": "12AD45FE30R29",
            "type": "integrationCode"
          }
        ]
      }
    ],
    "include": ["Analytics", "AudienceManager"],
    "expandIds": false,
    "priority": "normal",
    "analyticsDeleteMethod": "anonymize",
    "regulation": "ccpa"
}'

属性
描述
companyContexts (必需)
包含组织身份验证信息的数组。 每个列出的标识符都包含以下属性:
  • namespace :标识符的命名空间。
  • value :标识符的值。
必须 使用 其中一个标识符 imsOrgId 作为其 namespace 的标识符,其 value 中包含IMS组织的唯一ID。
其他标识符可以是特定于产品的公司限定符( Campaign 例如),它们标识与属于您组织的Adobe应用程序的集成。 潜在值包括帐户名、客户端代码、租户ID或其他应用程序标识符。
users (必需)
包含至少一个用户集合的数组,您希望访问或删除其信息。 单个请求中最多可提供1000个用户ID。 每个用户对象都包含以下信息:
  • key :用户的标识符,用于限定响应数据中单独的作业ID。 为此值选择唯一、易于识别的字符串是最佳做法,这样便可以方便地引用或稍后查找。
  • action :列表用户数据所需操作的数组。 根据您要执行的操作,此数组必须包括或 access 同时 delete 包括这两个操作。
  • userIDs :用户的身份集合。 单个用户可以拥有的身份数量限制为9个。 每个标识都包 namespace 含一个、 value 一个和一个命名空间限定符( type )。 有关这些 必需属性 的更多详细信息,请参阅附录。
有关和的更详细说 users 明, userIDs 请参阅故 障排除指南
include (必需)
要包含在处理中的Adobe产品阵列。 如果此值缺失或为空,则请求将被拒绝。 仅包含您的组织已集成的产品。 有关详细信息,请 参阅附录 中有关已接受产品值的部分。
expandIDs
一个可选属性,当设置为 true 时,它表示处理应用程序中ID的优化(当前仅受支 Analytics持)。 If omitted, this value defaults to false .
priority
Adobe Analytics使用的一个可选属性,它设置处理请求的优先级。 接受的值 normal 是和 low 。 如 priority 果省略,则默认行为为 normal
analyticsDeleteMethod
一个可选属性,指定Adobe Analytics如何处理个人数据。 此属性接受两个可能的值:
  • anonymize :给定用户ID集合引用的所有数据均为匿名数据。 如果 analyticsDeleteMethod 省略,则这是默认行为。
  • purge :所有数据都被完全删除。
regulation (必需)
申请的规定。 必须是以下四个值之一:
  • gdpr
  • ccpa
  • lgpd_bra
  • pdpa_tha
响应
成功的响应会返回新创建的作业的详细信息。
{
    "jobs": [
        {
            "jobId": "6fc09b53-c24f-4a6c-9ca2-c6076b0842b6",
            "customer": {
                "user": {
                    "key": "DavidSmith",
                    "action": [
                        "access"
                    ]
                }
            }
        },
        {
            "jobId": "6fc09b53-c24f-4a6c-9ca2-c6076be029f3",
            "customer": {
                "user": {
                    "key": "user12345",
                    "action": [
                        "access"
                    ]
                }
            }
        },
        {
            "jobId": "6fc09b53-c24f-4a6c-9ca2-c6076bd023j1",
            "customer": {
                "user": {
                    "key": "user12345",
                    "action": [
                        "delete"
                    ]
                }
            }
        }
    ],
    "requestStatus": 1,
    "totalRecords": 3
}

属性
描述
jobId
作业的只读、唯一的系统生成的ID。 此值用于查找特定作业的下一步。
成功提交作业请求后,您可以继续执行检查作 业状态的下一步

检查作业的状态

通过将特定作业包含在到端点的GET请求路径中,可以检索有关该作业( jobId 如其当前处理状态)的 /jobs 信息。
以前创建的作业的数据仅在作业完成日期后30天内可供检索。
API格式
GET /jobs/{JOB_ID}

参数
描述
{JOB_ID}
要查找的工作的ID。 此ID在成功的API jobId 响应中返回, 用于创建作业 列出所有作业
请求
以下请求检索请求路径中提供 jobId 的作业的详细信息。
curl -X GET \
  https://platform.adobe.io/data/core/privacy/jobs/6fc09b53-c24f-4a6c-9ca2-c6076b0842b6 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}'

响应
成功的响应会返回指定作业的详细信息。
{
    "jobId": "6fc09b53-c24f-4a6c-9ca2-c6076b0842b6",
    "requestId": "15700479082313109RX-899",
    "userKey": "David Smith",
    "action": "access",
    "status": "complete",
    "submittedBy": "{ACCOUNT_ID}",
    "createdDate": "10/02/2019 08:25 PM GMT",
    "lastModifiedDate": "10/02/2019 08:25 PM GMT",
    "userIds": [
        {
            "namespace": "email",
            "value": "dsmith@acme.com",
            "type": "standard",
            "namespaceId": 6,
            "isDeletedClientSide": false
        },
        {
            "namespace": "ECID",
            "value": "1123A4D5690B32A",
            "type": "standard",
            "namespaceId": 4,
            "isDeletedClientSide": false
        }
    ],
    "productResponses": [
        {
            "product": "Analytics",
            "retryCount": 0,
            "processedDate": "10/02/2019 08:25 PM GMT",
            "productStatusResponse": {
                "status": "complete",
                "message": "Success",
                "responseMsgCode": "PRVCY-6000-200",
                "responseMsgDetail": "Finished successfully."
            }
        },
        {
            "product": "Profile",
            "retryCount": 0,
            "processedDate": "10/02/2019 08:25 PM GMT",
            "productStatusResponse": {
                "status": "complete",
                "message": "Success",
                "responseMsgCode": "PRVCY-6000-200",
                "responseMsgDetail": "Success dataSetIds = [5dbb87aad37beb18a96feb61], Failed dataSetIds = []"
            }
        },
        {
            "product": "AudienceManager",
            "retryCount": 0,
            "processedDate": "10/02/2019 08:25 PM GMT",
            "productStatusResponse": {
                "status": "complete",
                "message": "Success",
                "responseMsgCode": "PRVCY-6054-200",
                "responseMsgDetail": "PARTIALLY COMPLETED- Data not found for some requests, check results for more info.",
                "results": {
                  "processed": ["1123A4D5690B32A"],
                  "ignored": ["dsmith@acme.com"]
                }
            }
        }
    ],
    "downloadURL": "http://...",
    "regulation": "ccpa"
}

属性
描述
productStatusResponse
数组中的每个 productResponses 对象都包含有关特定应用程序的作业当前状态的 Experience Cloud 信息。
productStatusResponse.status
作业的当前状态类别。 请参见下表,了解可用状 态类别的列表 及其相应含义。
productStatusResponse.message
作业的特定状态,对应于状态类别。
productStatusResponse.responseMsgCode
接收的产品响应消息的标准代码 Privacy Service。 消息的详细信息在下面提供 responseMsgDetail
productStatusResponse.responseMsgDetail
对工作状态的更详细说明。 处于相似状态的消息可能因产品而异。
productStatusResponse.results
对于某些状态,某些产品可能会返回 results 一个对象,该对象提供未涵盖的其他信 responseMsgDetail 息。
downloadURL
如果作业的状态为 complete ,则此属性提供URL以ZIP文件形式下载作业结果。 作业完成后60天内可下载此文件。

作业状态类别

下表列表了不同的可能作业状态类别及其相应含义:
状态类别
意义
complete
作业已完成,并且(如果需要)文件从每个应用程序上传。
processing
应用程序已确认该作业,并且当前正在处理。
submitted
工作会提交到每个适用的应用程序。
error
处理作业时出现故障——通过检索单个作业详细信息可获得更具体的信息。
如果已提交的作业仍有 processing 正在处理的从属子作业,则该作业可能仍处于状态。

后续步骤

您现在了解如何使用API创建和监视隐私工 Privacy Service 作。 有关如何使用用户界面执行相同任务的信息,请参阅 Privacy ServiceUI概述