프로필 시스템 작업 끝점(요청 삭제)

Adobe Experience Platform을 사용하면 여러 소스에서 데이터를 수집하고 개별 고객을 위한 강력한 프로필을 구축할 수 있습니다. Platform에 수집된 데이터는 Data Lake에 저장되며, 프로필에 대해 데이터 세트가 활성화된 경우 해당 데이터도 Real-time Customer Profile 데이터 스토어에 저장됩니다. 더 이상 필요하지 않거나 오류 시 추가된 데이터를 제거하려면 프로필 저장소에서 데이터 세트 또는 일괄 처리를 삭제해야 할 수 있습니다. 이를 위해서는 Real-time Customer Profile API를 사용하여 Profile 시스템 작업 또는 delete request를 만들어야 하는데, 이 작업은 필요할 경우 수정, 모니터링 또는 제거할 수도 있습니다.

노트

Data Lake에서 데이터 세트 또는 배치를 삭제하려는 경우 카탈로그 서비스 개요를 방문하여 자세한 내용을 확인하십시오.

시작하기

이 안내서에 사용된 API 엔드포인트는 Real-time Customer Profile API의 일부입니다. 계속하기 전에 시작 안내서에서 관련 설명서에 대한 링크, 이 문서에서 샘플 API 호출을 읽는 방법에 대한 안내서, 모든 Experience Platform API를 성공적으로 호출하는 데 필요한 필수 헤더에 대한 중요한 정보를 검토하십시오.

삭제 요청 보기

삭제 요청은 오래 실행되는 비동기 프로세스이므로 조직에서 한 번에 여러 개의 삭제 요청을 실행할 수 있습니다. 조직에서 현재 실행 중인 모든 삭제 요청을 보려면 /system/jobs 종단점에 대한 GET 요청을 수행할 수 있습니다.

선택적 쿼리 매개 변수를 사용하여 응답에서 반환된 삭제 요청 목록을 필터링할 수도 있습니다. 여러 매개 변수를 사용하려면 앰퍼샌드(&)를 사용하여 각 매개 변수를 구분하십시오.

API 형식

GET /system/jobs
GET /system/jobs?{QUERY_PARAMETERS}
매개 변수 설명
start 요청 만들기 시간에 따라 반환된 결과 페이지를 오프셋합니다. 예: start=4
limit 반환된 결과 수를 제한합니다. 예: limit=10
page 요청의 생성 시간에 따라 특정 결과 페이지를 반환합니다. 예: page=2
sort 오름차순(asc) 또는 내림차순(desc) 순서로 결과를 특정 필드로 정렬합니다. 여러 결과 페이지를 반환하는 경우 정렬 매개 변수가 작동하지 않습니다. 예: sort=batchId:asc

요청

curl -X GET \
  https://platform.adobe.io/data/core/ups/system/jobs \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

응답

응답에는 해당 요청의 세부 정보가 포함된 각 삭제 요청에 대한 개체가 있는 "children" 배열이 포함되어 있습니다.

{
  "_page": {
    "count": 100,
    "next": "K1JJRDpFaWc5QUwyZFgtMEpBQUFBQUFBQUFBPT0jUlQ6MSNUUkM6MiNGUEM6QWdFQUFBQVFBQWZBQUg0Ly9yL25PcmpmZndEZUR3QT0="
  },
  "children": [
    {
      "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
      "imsOrgId": "{IMS_ORG}",
      "batchId": "8d075b5a178e48389126b9289dcfd0ac",
      "jobType": "DELETE",
      "status": "COMPLETED",
      "metrics": "{\"recordsProcessed\":5,\"timeTakenInSec\":1}",
      "createEpoch": 1559026134,
      "updateEpoch": 1559026137
    },
    {
      "id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
      "imsOrgId": "{IMS_ORG}",
      "dataSetId": "5c802d3cd83fc114b741c4b5",
      "jobType": "DELETE",
      "status": "PROCESSING",
      "metrics": "{\"recordsProcessed\":0,\"timeTakenInSec\":15}",
      "createEpoch": 1559025404,
      "updateEpoch": 1559025406
    }
  ]
}
속성 설명
_page.count 총 요청 수입니다. 이 응답은 스페이스에 대해 잘렸습니다.
_page.next 결과의 추가 페이지가 있는 경우 조회 요청의 ID 값을 제공된 "next" 값으로 대체하여 결과의 다음 페이지를 봅니다.
jobType 만들어지는 작업 유형입니다. 이 경우 항상 "DELETE"을 반환합니다.
status 삭제 요청의 상태입니다. 가능한 값은 "NEW", "PROCESSING", "COMPLETED", "ERROR"입니다.
metrics 처리된 레코드 수("recordsProcessed")와 요청이 처리된 시간(초) 또는 요청이 완료되는 데 걸린 시간을 포함하는 개체입니다("timeTakenInSec").

삭제 요청 만들기

새 삭제 요청을 시작하는 것은 /systems/jobs 종단점에 대한 POST 요청을 통해 수행되며, 여기서 삭제할 데이터 세트 또는 일괄 처리의 ID가 요청 본문에 제공됩니다.

데이터 집합 삭제

프로필 저장소에서 데이터 세트를 삭제하려면 데이터 세트 ID를 POST 요청 본문에 포함해야 합니다. 이 작업은 주어진 데이터 세트에 대한 모든 데이터를 삭제합니다. Experience Platform 레코드 및 시계열 스키마를 모두 기반으로 데이터 세트를 삭제할 수 있습니다.

API 형식

POST /system/jobs

요청

curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "dataSetId": "5c802d3cd83fc114b741c4b5"
      }'
속성 설명
dataSetId (필수) 삭제할 데이터 세트의 ID입니다.

응답

성공적인 응답은 요청에 대한 고유한 시스템 생성, 읽기 전용 ID를 포함하여 새로 생성된 삭제 요청의 세부 정보를 반환합니다. 요청을 조회하고 상태를 확인하는 데 사용할 수 있습니다. 생성 시 요청에 대한 status은 처리가 시작될 때까지 "NEW"입니다. 응답의 dataSetId은(는) 요청에 전송된 dataSetId과(와) 일치해야 합니다.

{
    "id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
    "imsOrgId": "{IMS_ORG}",
    "dataSetId": "5c802d3cd83fc114b741c4b5",
    "jobType": "DELETE",
    "status": "NEW",
    "createEpoch": 1559025404,
    "updateEpoch": 1559025406
}
속성 설명
id 삭제 요청의 고유한 시스템 생성, 읽기 전용 ID입니다.
dataSetId POST 요청에 지정된 데이터 세트의 ID입니다.

배치 삭제

배치를 삭제하려면 배치 ID를 POST 요청 본문에 포함해야 합니다. 레코드 스키마를 기준으로 데이터 세트에 대한 일괄 처리는 삭제할 수 없습니다. 시계열 스키마를 기반으로 한 데이터 세트에 대한 배치만 삭제할 수 있습니다.

노트

레코드 스키마를 기반으로 데이터 세트에 대한 배치를 삭제할 수 없는 이유는 레코드 유형 데이터 세트 배치가 이전 레코드를 덮어쓰므로 "실행 취소" 또는 삭제할 수 없기 때문입니다. 레코드 스키마를 기반으로 데이터 세트에 대한 잘못된 배치가 미치는 영향을 제거할 수 있는 유일한 방법은 잘못된 레코드를 덮어쓰려면 올바른 데이터로 배치를 다시 수집하는 것입니다.

레코드 및 시계열 동작에 대한 자세한 내용은 XDM System 개요에서 XDM 데이터 동작🔗의 섹션을 검토하십시오.

API 형식

POST /system/jobs

요청

curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
       "batchId": "8d075b5a178e48389126b9289dcfd0ac"
      }'
속성 설명
batchId (필수) 삭제할 일괄 처리의 ID입니다.

응답

성공적인 응답은 요청에 대한 고유한 시스템 생성, 읽기 전용 ID를 포함하여 새로 생성된 삭제 요청의 세부 정보를 반환합니다. 요청을 조회하고 상태를 확인하는 데 사용할 수 있습니다. 생성 시 요청에 대한 "status"은 처리가 시작될 때까지 "NEW"입니다. 응답의 "batchId" 값은 요청에 전송된 "batchId" 값과 일치해야 합니다.

{
    "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "imsOrgId": "{IMS_ORG}",
    "batchId": "8d075b5a178e48389126b9289dcfd0ac",
    "jobType": "DELETE",
    "status": "NEW",
    "createEpoch": 1559026131,
    "updateEpoch": 1559026132
}
속성 설명
id 삭제 요청의 고유한 시스템 생성, 읽기 전용 ID입니다.
batchId POST 요청에 지정된 일괄 처리의 ID입니다.

레코드 데이터 세트 배치에 대한 삭제 요청을 시작하려고 하면 다음과 같이 400 수준 오류가 발생합니다.

{
    "requestId": "bc4eb29f-63a8-4653-9133-71238884bb81",
    "errors": {
        "400": [
            {
                "code": "500",
                "message": "Batch can only be specified for EE type 'a294e36d382649dab2cc6ad64a41b674'"
            }
        ]
    }
}

특정 삭제 요청 보기

상태 등의 세부 정보를 포함하여 특정 삭제 요청을 보려면 /system/jobs 종단점에 조회(GET) 요청을 수행하고 경로에 삭제 요청의 ID를 포함할 수 있습니다.

API 형식

GET /system/jobs/{DELETE_REQUEST_ID}
매개 변수 설명
{DELETE_REQUEST_ID} (필수) 보려는 삭제 요청의 ID입니다.

요청

curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs/9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

응답

이 응답에는 업데이트된 상태를 포함하여 삭제 요청의 세부 정보가 제공됩니다. 응답의 삭제 요청 ID( "id" 값)는 요청 경로에 전송된 ID와 일치해야 합니다.

{
    "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "imsOrgId": "{IMS_ORG}",
    "batchId": "8d075b5a178e48389126b9289dcfd0ac",
    "jobType": "DELETE",
    "status": "COMPLETED",
    "metrics": "{\"recordsProcessed\":5,\"timeTakenInSec\":1}",
    "createEpoch": 1559026134,
    "updateEpoch": 1559026137
}
속성 설명
jobType 만들어지는 작업 유형입니다. 이 경우 항상 "DELETE"을 반환합니다.
status 삭제 요청의 상태입니다. 가능한 값: "NEW", "PROCESSING", "COMPLETED", "ERROR".
metrics 처리된 레코드 수("recordsProcessed")와 요청이 처리된 시간(초) 또는 요청이 완료되는 데 걸린 시간을 포함하는 배열입니다("timeTakenInSec").

삭제 요청 상태가 "COMPLETED"이면 데이터 액세스 API를 사용하여 삭제된 데이터에 액세스하려고 하여 데이터가 삭제되었는지 확인할 수 있습니다. 데이터 액세스 API를 사용하여 데이터 세트 및 배치에 액세스하는 방법에 대한 지침은 데이터 액세스 설명서를 검토하십시오.

삭제 요청 제거

Experience Platform 이전 요청을 삭제할 수 있도록 해줍니다. 이 작업은 삭제 작업이 완료되지 않았거나 처리 단계에서 중단된 경우를 비롯하여 다양한 이유로 유용할 수 있습니다. 삭제 요청을 제거하려면 /system/jobs 종단점에 DELETE 요청을 수행하고 요청 경로에 제거할 삭제 요청의 ID를 포함할 수 있습니다.

API 형식

DELETE /system/jobs/{DELETE_REQUEST_ID}
매개 변수 설명
제거할 삭제 요청의 ID입니다.

요청

curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs/9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

응답

삭제 요청이 성공하면 HTTP 상태 200(OK) 및 빈 응답 본문을 반환합니다. 해당 ID로 삭제 요청을 보기 위한 GET 요청을 수행하여 요청이 삭제되었는지 확인할 수 있습니다. 삭제 요청이 제거되었음을 나타내는 HTTP 상태 404(찾을 수 없음)를 반환해야 합니다.

다음 단계

이제 Experience Platform 내의 Profile Store에서 데이터 세트 및 배치를 삭제하는 단계를 알고 있으므로 잘못 추가되었거나 조직에서 더 이상 필요하지 않은 데이터를 안전하게 삭제할 수 있습니다. 삭제 요청은 취소할 수 없으므로 현재는 필요하지 않으며 향후에는 필요하지 않을 것으로 확신하는 데이터만 삭제해야 합니다.

이 페이지에서는