개인 정보 작업 끝점

이 문서에서는 API 호출을 사용하여 개인 정보 작업을 사용하는 방법에 대해 설명합니다. 특히 Privacy Service API에서 /job 끝점의 사용을 다룹니다. 이 안내서를 읽기 전에 필수 헤더 및 예제 API 호출 방법을 포함하여 API를 성공적으로 호출하기 위해 알아야 하는 중요한 정보는 시작 섹션을 참조하십시오.

모든 작업 목록

/jobs 종단점에 GET 요청을 함으로써 조직 내에서 사용 가능한 모든 개인 정보 작업 목록을 볼 수 있습니다.

API 형식

이 요청 형식은 /jobs 끝점에 regulation 쿼리 매개 변수를 사용하므로 아래와 같이 물음표(?)로 시작합니다. 응답이 페이지에 지정되어 있으므로 다른 쿼리 매개 변수(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}

요청

다음 요청은 페이지 크기가 50인 3번째 페이지에서 시작하여 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 끝점에 제공해야 합니다.

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"
}'

응답

성공적인 응답은 새로 만든 작업의 세부 정보를 반환합니다.

{
    "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
}

작업 요청을 성공적으로 제출하면 작업의 상태🔗을 확인하는 다음 단계로 진행할 수 있습니다.

작업 상태 확인

/jobs 종단점에 대한 GET 요청 경로에 해당 작업의 jobId을 포함하여 현재 처리 상태와 같은 특정 작업에 대한 정보를 검색할 수 있습니다.

API 형식

GET /jobs/{JOB_ID}

요청

다음 요청은 요청 경로에 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"
}

작업 상태 범주

다음 표에는 가능한 다양한 작업 상태 카테고리와 해당 의미가 나열됩니다.

다음 단계

이제 Privacy Service API를 사용하여 개인 정보 작업을 만들고 모니터링하는 방법을 알 수 있습니다. 사용자 인터페이스를 사용하여 동일한 작업을 수행하는 방법에 대한 자세한 내용은 Privacy Service UI 개요를 참조하십시오.