개인 정보 작업 끝점

이 문서에서는 API 호출을 사용하여 개인 정보 작업을 사용하는 방법을 설명합니다. 특히, /job 의 엔드포인트 Privacy Service API. 이 안내서를 읽기 전에 시작 안내서 필수 헤더 및 예제 API 호출을 읽는 방법을 포함하여 API를 성공적으로 호출하기 위해 알고 있어야 하는 중요한 정보입니다.

노트

고객의 동의 또는 옵트아웃 요청을 관리하려고 하는 경우 동의 끝점 안내서.

모든 작업 나열

에 GET 요청을 하여 조직 내에서 사용 가능한 모든 개인 정보 작업 목록을 볼 수 있습니다 /jobs 엔드포인트.

API 형식

이 요청 형식은 regulation 쿼리 매개 변수 /jobs 따라서 물음표(?)를 사용할 수 있습니다. 응답이 페이지 매김되어 다른 쿼리 매개 변수(pagesize)를 사용하여 응답을 필터링합니다. 앰퍼샌드( )를 사용하여 여러 매개 변수를 분리할 수 있습니다&).

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 (브라질)
  • nzpa_nzl (뉴질랜드)
  • 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: {ORG_ID}'

응답

성공한 응답은 작업 목록을 반환하고 각 작업에는 해당 작업과 같은 세부 정보가 포함됩니다 jobId. 이 응답에는 결과의 세 번째 페이지에서 시작하는 50개 작업 목록이 포함됩니다.

다음 페이지에 액세스

페이지 매김된 응답에서 다음 결과 세트를 가져오려면 를 늘리는 동안 동일한 종단점에 대해 다른 API 호출을 수행해야 합니다. page 쿼리 매개 변수 1.

개인 정보 작업 만들기

새 작업 요청을 만들기 전에 먼저 액세스, 삭제 또는 판매를 옵트아웃하려는 데이터가 있는 데이터 주체의 식별 정보를 수집해야 합니다. 필요한 데이터가 있으면 POST 요청의 페이로드에 제공해야 합니다 /jobs 엔드포인트.

노트

호환되는 Adobe Experience Cloud 응용 프로그램은 데이터 주체를 식별하는 데 다른 값을 사용합니다. 다음 안내서를 참조하십시오. Privacy Service 및 Experience Cloud 애플리케이션 를 참조하십시오. 전송할 ID를 결정하는 방법에 대한 일반적인 지침은 Privacy Service에서 문서를 참조하십시오. 개인 정보 보호 요청의 id 데이터.

다음 Privacy Service API는 개인 데이터에 대한 두 가지 종류의 작업 요청을 지원합니다.

중요

액세스 및 삭제 요청을 단일 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: {ORG_ID}' \
  -d '{
    "companyContexts": [
      {
        "namespace": "imsOrgID",
        "value": "{ORG_ID}"
      }
    ],
    "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: 사용자의 ID 컬렉션입니다. 한 사용자가 사용할 수 있는 ID의 수는 9개로 제한됩니다. 각 ID는 namespace, value, 및 네임스페이스 한정자(type). 자세한 내용은 부록 를 참조하십시오.
자세한 내용은 usersuserIDs를 참조하고 문제 해결 안내서.
include (필수 여부) 처리에 포함할 Adobe 제품 배열입니다. 이 값이 없거나 비어 있는 경우 요청이 거부됩니다. 조직이 통합하는 제품만 포함합니다. 의 섹션을 참조하십시오. 수락된 제품 값 자세한 내용은 부록에서 확인하십시오.
expandIDs 로 설정된 경우 true는 애플리케이션의 ID 처리를 위한 최적화를 나타냅니다(현재 Analytics). 생략하면 이 값의 기본값은 입니다. false.
priority 요청 처리 우선순위를 설정하는 Adobe Analytics에서 사용하는 선택적 속성입니다. 허용되는 값은 다음과 같습니다 normallow. If priority 이 생략되면 기본 동작은 normal.
analyticsDeleteMethod Adobe Analytics에서 개인 데이터를 처리하는 방법을 지정하는 선택적 속성입니다. 이 속성에 대해 가능한 두 개의 값이 허용됩니다.
  • anonymize: 지정된 사용자 ID 컬렉션에서 참조하는 모든 데이터는 익명으로 수행됩니다. If analyticsDeleteMethod 생략하면 기본 동작입니다.
  • purge: 모든 데이터가 완전히 제거됩니다.
regulation (필수 여부) 개인 정보 보호 업무에 대한 규정. 다음 값이 허용됩니다.
  • gdpr (유럽 연합)
  • ccpa (캘리포니아)
  • lgpd_bra (브라질)
  • nzpa_nzl (뉴질랜드)
  • 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입니다. 이 값은 특정 작업을 검색하는 다음 단계에서 사용됩니다.

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

작업 상태 확인

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

중요

이전에 생성된 작업에 대한 데이터는 작업 완료 날짜로부터 30일 이내에만 검색할 수 있습니다.

API 형식

GET /jobs/{JOB_ID}
매개 변수 설명
{JOB_ID} 조회하려는 작업의 ID입니다. 이 ID는 jobId 에 대한 성공적인 API 응답 작업 만들기모든 작업 목록.

요청

다음 요청은 작업 세부 정보를 검색합니다. 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: {ORG_ID}'

응답

성공한 응답은 지정된 작업의 세부 정보를 반환합니다.

{
    "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로 지정하는 경우 이 속성은 작업 결과를 ZIP 파일로 다운로드할 URL을 제공합니다. 이 파일은 작업이 완료된 후 60일 동안 다운로드할 수 있습니다.

작업 상태 범주

다음 표에는 가능한 다양한 작업 상태 범주 및 해당 의미가 나열됩니다.

상태 카테고리 의미
complete 작업이 완료되었으며(필요한 경우) 모든 애플리케이션에서 파일이 업로드됩니다.
processing 응용 프로그램이 작업을 승인했으며 현재 처리 중입니다.
submitted 적용 가능한 모든 응용 프로그램에 작업이 제출됩니다.
error 작업 처리에 오류가 발생했습니다. 개별 작업 세부 정보를 검색하여 더 구체적인 정보를 얻을 수 있습니다.
노트

제출된 작업은 processing 여전히 처리 중인 종속 하위 작업이 있는 경우 상태로 두십시오.

다음 단계

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

이 페이지에서는