개인 정보 작업 엔드포인트
이 문서에서는 API 호출을 사용하여 개인 정보 작업을 사용하는 방법을 다룹니다. 특히 Privacy Service API에서 /job
끝점을 사용하는 경우를 다룹니다. 이 안내서를 읽기 전에 필수 헤더와 예제 API 호출을 읽는 방법 등 API를 성공적으로 호출하기 위해 알아야 할 중요한 정보는 시작 안내서를 참조하십시오.
모든 작업 나열 list
/jobs
끝점에 대한 GET 요청을 통해 조직 내에서 사용 가능한 모든 개인 정보 작업 목록을 볼 수 있습니다.
API 형식
이 요청 형식은 /jobs
끝점에서 regulation
쿼리 매개 변수를 사용하므로 아래 표시된 대로 물음표(?
)로 시작합니다. 리소스를 나열할 때 Privacy Service API는 최대 1000개의 작업을 반환하고 응답에 페이지를 매깁니다. 다른 쿼리 매개 변수(page
, size
및 날짜 필터)를 사용하여 응답을 필터링합니다. 앰퍼샌드(&
)를 사용하여 여러 매개 변수를 구분할 수 있습니다.
status
, fromDate
및 toDate
쿼리 매개 변수를 사용하는 상태를 확인할 수 있습니다.GET /jobs?regulation={REGULATION}
GET /jobs?regulation={REGULATION}&page={PAGE}
GET /jobs?regulation={REGULATION}&size={SIZE}
GET /jobs?regulation={REGULATION}&page={PAGE}&size={SIZE}
GET /jobs?regulation={REGULATION}&fromDate={FROMDATE}&toDate={TODATE}&status={STATUS}
{REGULATION}
쿼리할 규정 유형. 허용되는 값은 다음과 같습니다.
apa_aus
cpa_usa
cpra_usa
ctdpa_usa
fdbr_usa
gdpr
- 참고: ccpa 규제와 관련된 요청에도 사용됩니다.hipaa_usa
icdpa_usa
lgpd_bra
mcdpa_usa
mhmda_usa
ndpa_usa
nhpa_usa
njdpa_usa
nzpa_nzl
ocpa_usa
pdpa_tha
tdpsa_usa
ucpa_usa
vcdpa_usa
위의 값이 나타내는 개인 정보 보호 규정에 대한 자세한 내용은 지원되는 규정에 대한 개요를 참조하십시오.
{PAGE}
0
입니다.{SIZE}
100
이고 최대값은 1000
입니다. 최대값을 초과하면 API가 400 코드 오류를 반환합니다.{status}
기본 동작은 모든 상태를 포함하는 것입니다. 상태 유형을 지정하면 요청은 해당 상태 유형과 일치하는 개인 정보 작업만 반환합니다. 허용되는 값은 다음과 같습니다.
processing
complete
error
{toDate}
YYYY-MM-DD 형식을 허용합니다. 제공한 날짜는 그리니치 표준시(GMT)로 표시되는 종료 날짜로 해석됩니다.
이 매개 변수(및 해당
fromDate
)를 제공하지 않으면 기본 동작은 지난 7일 동안 데이터를 다시 가져온 작업을 반환합니다. toDate
을(를) 사용하는 경우 fromDate
쿼리 매개 변수도 사용해야 합니다. 두 가지를 모두 사용하지 않으면 호출에서 400 오류가 반환됩니다.{fromDate}
YYYY-MM-DD 형식을 허용합니다. 제공한 날짜는 그리니치 표준시(GMT)로 표시되는 요청의 시작 날짜로 해석됩니다.
이 매개 변수(및 해당
toDate
)를 제공하지 않으면 기본 동작은 지난 7일 동안 데이터를 다시 가져온 작업을 반환합니다. fromDate
을(를) 사용하는 경우 toDate
쿼리 매개 변수도 사용해야 합니다. 두 가지를 모두 사용하지 않으면 호출에서 400 오류가 반환됩니다.{filterDate}
요청
다음 요청은 페이지 크기가 50인 세 번째 페이지부터 시작하여 조직 내의 모든 작업에 대한 페이지 매김된 목록을 검색합니다.
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개의 작업 목록이 포함됩니다.
후속 페이지 액세스
페이지가 매겨진 응답에서 다음 결과 집합을 가져오려면 page
쿼리 매개 변수를 1씩 증가시키면서 동일한 끝점에 대해 다른 API 호출을 수행해야 합니다.
개인 정보 작업 만들기 create-job
새 Job 요청을 작성하기 전에 먼저 데이터에 액세스하거나, 삭제하거나, 판매를 거부하려는 데이터 주체에 대한 식별 정보를 수집해야 합니다. 필요한 데이터가 있으면 /jobs
끝점에 대한 POST 요청의 페이로드에 제공해야 합니다.
Privacy Service API는 개인 데이터에 대한 두 종류의 작업 요청을 지원합니다.
- 액세스 및/또는 삭제: 개인 데이터에 액세스(읽기)하거나 삭제합니다.
- 판매 중지: 개인 데이터를 판매되지 않도록 표시합니다.
액세스/삭제 작업 만들기 access-delete
이 섹션에서는 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","profileService"],
"expandIds": false,
"priority": "normal",
"mergePolicyId": 124,
"regulation": "ccpa"
}'
companyContexts
(필수)조직의 인증 정보가 포함된 배열입니다. 나열된 각 식별자에는 다음 속성이 포함됩니다.
namespace
: 식별자의 네임스페이스입니다.value
: 식별자의 값입니다.
식별자 중 하나에서 imsOrgId
을(를) namespace
(으)로 사용하고 value
에 조직의 고유 ID가 포함된 것은 필수 입니다.
추가 식별자는 제품별 회사 한정자(예: Campaign
)일 수 있으며, 조직에 속한 Adobe 응용 프로그램과의 통합을 식별합니다. 잠재적 값에는 계정 이름, 클라이언트 코드, 테넌트 ID 또는 기타 애플리케이션 식별자가 포함됩니다.
users
(필수)액세스하거나 삭제하려는 정보를 가진 하나 이상의 사용자 컬렉션이 포함된 배열입니다. 단일 요청으로 최대 1000명의 사용자를 제공할 수 있습니다. 각 사용자 객체에는 다음 정보가 포함됩니다.
key
: 응답 데이터에서 개별 작업 ID를 구분하는 데 사용되는 사용자의 식별자입니다. 이 값을 쉽게 참조하거나 나중에 조회할 수 있도록 고유하고 쉽게 식별 가능한 문자열을 선택하는 것이 좋습니다.action
: 사용자 데이터에 대해 수행할 작업을 나열하는 배열입니다. 수행하려는 작업에 따라 이 배열에는access
,delete
또는 두 가지가 모두 포함되어야 합니다.userIDs
: 사용자의 ID 컬렉션입니다. 단일 사용자가 가질 수 있는 ID의 수는 9개로 제한됩니다. 각 ID는namespace
,value
및 네임스페이스 한정자(type
)로 구성됩니다. 이러한 필수 속성에 대한 자세한 내용은 부록을 참조하십시오.
users
및 userIDs
에 대한 자세한 내용은 문제 해결 안내서를 참조하십시오.
include
(필수)expandIDs
true
(으)로 설정된 경우 응용 프로그램에서 ID를 처리하기 위한 최적화를 나타내는 선택적 속성입니다(현재 Analytics에서만 지원됨). 생략하면 이 값의 기본값은 false
입니다.priority
normal
및 low
입니다. priority
을(를) 생략하면 기본 동작은 normal
입니다.mergePolicyId
profileService
)에 대한 개인 정보 보호 요청을 할 때 선택적으로 ID 결합에 사용할 특정 병합 정책의 ID를 제공할 수 있습니다. 병합 정책을 지정하여 개인 정보 보호 요청은 고객에 대한 데이터를 반환할 때 대상 정보를 포함할 수 있습니다. 요청당 하나의 병합 정책만 지정할 수 있습니다. 병합 정책이 제공되지 않으면 세그멘테이션 정보가 응답에 포함되지 않습니다.regulation
(필수)개인 정보 보호 작업에 대한 규정. 다음 값이 허용됩니다.
apa_aus
ccpa
cpra_usa
gdpr
hipaa_usa
lgpd_bra
nzpa_nzl
pdpa_tha
vcdpa_usa
위의 값이 나타내는 개인 정보 보호 규정에 대한 자세한 내용은 지원되는 규정에 대한 개요를 참조하십시오.
응답
성공한 응답은 새로 생성된 작업의 세부 정보를 반환합니다.
{
"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
작업 요청을 성공적으로 제출하면 작업 상태 확인의 다음 단계로 진행할 수 있습니다.
작업 상태 확인 check-status
/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: {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
responseMsgDetail
에 나와 있습니다.productStatusResponse.responseMsgDetail
productStatusResponse.results
responseMsgDetail
에서 다루지 않는 추가 정보를 제공하는 results
개체를 반환할 수 있습니다.downloadURL
complete
인 경우 이 특성은 작업 결과를 ZIP 파일로 다운로드할 수 있는 URL을 제공합니다. 이 파일은 작업이 완료된 후 60일 동안 다운로드할 수 있습니다.작업 상태 범주 status-categories
다음 표에는 가능한 다양한 작업 상태 범주와 해당 의미가 나열되어 있습니다.
complete
processing
submitted
error
processing
상태가 유지될 수 있습니다.다음 단계
이제 Privacy Service API를 사용하여 개인 정보 작업을 만들고 모니터링하는 방법을 배웁니다. 사용자 인터페이스를 사용하여 동일한 작업을 수행하는 방법에 대한 자세한 내용은 Privacy Service UI 개요를 참조하십시오.