데이터 세트 만료 끝점
Adobe Experience Platform의 데이터 세트를 삭제해야 하는 시기를 예약하려면 데이터 위생 API의 /ttl
끝점을 사용하십시오.
데이터 세트 만료는 지연된 삭제 작업입니다. 데이터 세트는 중간에 보호되지 않으며 예약된 만료 전에 다른 방법으로 삭제될 수 있습니다.
삭제가 시작되기 전에 만료를 취소하거나 예약 시간을 변경할 수 있습니다. 취소된 만료를 다시 열려면 새 만료를 설정하십시오.
삭제가 시작되면 만료 작업이 executing
(으)로 표시되어 더 이상 수정할 수 없습니다. 데이터 세트는 최대 7일 동안 복구할 수 있지만 수동 Adobe 서비스 요청을 통해서만 복구할 수 있습니다. 삭제하는 동안 데이터 레이크, ID 서비스 및 실시간 고객 프로필은 각각 데이터 세트 콘텐츠를 개별적으로 제거합니다. 삭제가 완료되면 만료는 completed
(으)로 표시됩니다.
Advanced Data Lifecycle Management는 데이터 집합 만료 끝점을 통해 데이터 집합 삭제를 지원하고 작업 주문 끝점을 통해 기본 ID를 사용하여 ID 삭제(행 수준 데이터)를 지원합니다. Experience Platform UI를 통해 데이터 세트 만료 및 레코드 삭제을 관리할 수도 있습니다. 자세한 내용은 연결된 설명서 를 참조하십시오.
시작
이 안내서에 사용된 끝점은 데이터 위생 API의 일부입니다. 계속하기 전에 API 안내서에서 CRUD 작업에 필요한 헤더, 오류 메시지, Postman 컬렉션 및 샘플 API 호출 읽기 방법에 대한 정보를 검토하십시오.
x-sandbox-name: {SANDBOX_NAME}
헤더를 사용해야 합니다.데이터 세트 만료 나열 list
/ttl
끝점에 대한 GET 요청을 수행하여 조직에 대해 구성된 모든 데이터 세트 만료를 나열할 수 있습니다.
쿼리 매개 변수를 사용하여 결과를 필터링하여 기준에 맞는 만료만을 반환합니다. 각 결과에는 각 데이터 세트 만료에 대한 상태 및 구성 세부 정보가 포함됩니다.
API 형식
GET /ttl?{QUERY_PARAMETERS}
{QUERY_PARAMETERS}
&
자로 구분된 여러 매개 변수가 있는 선택적 쿼리 매개 변수 목록입니다. 일반적인 매개 변수에는 페이지 매김을 위해 limit
및 page
이(가) 포함됩니다. 지원되는 쿼리 매개 변수의 전체 목록을 보려면 부록 섹션에서 지원되는 쿼리 매개 변수의 전체 목록을 참조하십시오. 가장 일반적으로 사용되는 모수는 아래 부록뿐만 아니라 다음과 같다.author
LIKE %john%
).datasetId
datasetName
status
pending
, executing
, cancelled
, completed
.expiryDate
limit
page
요청
다음 요청은 2021년 8월 1일 이전에 업데이트되고, 이름이 "Jane Doe"와 일치하는 사용자가 마지막으로 업데이트한 모든 데이터 세트 만료를 검색합니다.
curl -X GET \
https://platform.adobe.io/data/core/hygiene/ttl?updatedToDate=2021-08-01&author=LIKE%20%25Jane%20Doe%25 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
응답
성공적인 응답에는 데이터 세트의 만료 결과가 표시됩니다. 다음 예제는 공백에 대해 잘렸습니다.
ttlId
은(는) {DATASET_EXPIRATION_ID}
이라고도 합니다. 둘 다 데이터 세트 만료에 대한 고유 식별자를 참조합니다.{
"results": [
{
"ttlId": "SD-c9f113f2-d751-44bc-bc20-9d5ca0b6ae15",
"datasetId": "3e9f815ae1194c65b2a4c5ea",
"datasetName": "Acme_Profile_Engagements",
"sandboxName": "acme-beta",
"displayName": "Engagement Data Retention Policy",
"description": "Scheduled expiry for Acme marketing data",
"imsOrg": "C9D8E7F6A5B41234567890AB@AcmeOrg",
"status": "pending",
"expiry": "2027-01-12T17:15:31.000Z",
"updatedAt": "2026-12-15T12:40:20.000Z",
"updatedBy": "t.lannister@acme.com <t.lannister@acme.com> 3E9F815AE1194C65B2A4C5EA@acme.com"
}
],
"current_page": 0,
"total_pages": 1,
"total_count": 1
}
results
ttlId
datasetId
datasetName
sandboxName
displayName
description
imsOrg
status
pending
, executing
, cancelled
, completed
중 하나.expiry
updatedAt
updatedBy
current_page
total_pages
total_count
데이터 세트 만료 조회 lookup
데이터 세트 만료 ID 또는 데이터 세트 ID를 경로 매개 변수로 사용하여 GET 요청을 수행함으로써 특정 데이터 세트 만료 구성에 대한 세부 정보를 검색합니다.
SD-xxxxxx-xxxx
) 또는 경로에 데이터 세트 ID를 제공할 수 있습니다. 응답의 ttlId
은(는) 데이터 집합 만료에 대한 고유 식별자입니다.API 형식
GET /ttl/{ID}
GET /ttl/{ID}?include=history
{ID}
include
history
(으)로 설정된 경우 응답에 구성에 대한 변경 이벤트가 있는 history
배열이 포함됩니다.요청
다음 요청은 데이터 집합 62759f2ede9e601b63a2ee14
에 대한 만료 세부 정보를 찾습니다.
curl -X GET \
https://platform.adobe.io/data/core/hygiene/ttl/62759f2ede9e601b63a2ee14 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
응답
성공적인 응답은 데이터 세트 만료의 세부 정보를 반환합니다.
{
"ttlId": "SD-c8c75921-2416-4be7-9cfd-9ab01de66c5f",
"datasetId": "62759f2ede9e601b63a2ee14",
"datasetName": "XtVRwq9-38734",
"sandboxName": "prod",
"displayName": "Delete Acme Data before 2025",
"description": "The Acme information in this dataset is licensed for our use through the end of 2024.",
"imsOrg": "885737B25DC460C50A49411B@AdobeOrg",
"status": "pending",
"expiry": "2035-09-25T00:00:00Z",
"updatedAt": "2025-05-01T19:00:55.000Z",
"updatedBy": "Jane Doe <jdoe@adobe.com> 77A51F696282E48C0A494 012@64d18d6361fae88d49412d.e",
}
ttlId
datasetId
datasetName
sandboxName
displayName
description
imsOrg
status
하나:
pending
, executing
, cancelled
, completed
.expiry
updatedAt
updatedBy
카탈로그 만료 태그
카탈로그 API를 사용하여 데이터 세트 세부 정보를 조회할 때 데이터 세트에 활성 만료가 있는 경우 tags.adobe/hygiene/ttl
아래에 나열됩니다.
다음 JSON은 만료 값이 32503680000000
인 데이터 집합에 대한 잘린 카탈로그 API 응답을 표시합니다. 태그는 Unix Epoch 이후 만료 시간을 밀리초 단위로 인코딩합니다.
{
"63212313c308d51b997858ba": {
"name": "Test Dataset",
"description": "A piecrust promise, made to be broken",
"imsOrg": "0FCC747E56F59C747F000101@AdobeOrg",
"sandboxId": "8dc51b90-d0f9-11e9-b164-ed6a398c8b35",
"tags": {
"adobe/hygiene/ttl": [ "32503680000000" ],
...
},
...
}
}
데이터 세트 만료 만들기 create
데이터 세트가 만료되어 삭제할 수 있는 시기를 정의할 새 데이터 세트 만료 구성을 만듭니다.
데이터 세트 ID, 만료 날짜 또는 날짜-시간(ISO 8601 형식), 표시 이름 및 설명(선택 사항)을 입력합니다.
데이터 세트 만료를 만들려면 아래와 같이 POST 요청을 보냅니다.
API 형식
POST /ttl
요청
curl -X POST \
https://platform.adobe.io/data/core/hygiene/ttl \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"datasetId": "3e9f815ae1194c65b2a4c5ea",
"expiry": "2030-12-31",
"displayName": "Expiry rule for Acme customers",
"description": "Set expiration for Acme customer dataset"
}'
datasetId
expiry
필수. ISO 8601 형식의 만료 날짜 및 시간입니다. 시스템 내 데이터의 수명을 정의합니다. 날짜만 제공되는 경우 기본값은 자정(UTC, 00:00:00Z)입니다. 만료 은(는) 적어도 24시간 이후여야 합니다.
참고:
- 데이터 세트에 대한 데이터 세트 만료가 이미 존재하는 경우 요청이 실패합니다.
displayName
description
응답
성공적인 응답은 HTTP 201(생성됨) 상태와 새 데이터 세트 만료 구성을 반환합니다.
{
"ttlId": "SD-2aaf113e-3f17-4321-bf29-a2c51152b042",
"datasetId": "3e9f815ae1194c65b2a4c5ea",
"datasetName": "Acme_Customer_Data",
"sandboxName": "acme-prod",
"displayName": "Expiry rule for Acme customers",
"description": "Set expiration for Acme customer dataset",
"imsOrg": "{ORG_ID}",
"status": "pending",
"expiry": "2030-12-31T00:00:00Z",
"updatedAt": "2025-01-02T10:35:45.000Z",
"updatedBy": "s.stark@acme.com <s.stark@acme.com> 3E9F815AE1194C65B2A4C5EA@acme.com"
}
ttlId
datasetId
datasetName
sandboxName
displayName
description
imsOrg
status
하나:
pending
, executing
, cancelled
, completed
.expiry
updatedAt
updatedBy
데이터 세트에 대한 데이터 세트 만료가 이미 존재하는 경우 400(잘못된 요청) HTTP 상태가 발생합니다. 이러한 데이터 세트가 없거나 데이터 세트에 대한 액세스 권한이 없는 경우 404(찾을 수 없음) HTTP 상태가 발생합니다.
데이터 세트 만료 구성 업데이트 update
기존 데이터 집합 만료 구성을 업데이트하려면 /ttl/DATASET_EXPIRATION_ID
에 PUT 요청을 하십시오. 구성의 displayName
, description
및 expiry
필드만 업데이트할 수 있습니다. 만료 상태가 pending
인 경우에만 업데이트가 허용됩니다.
expiry
필드는 날짜(YYYY-MM-DD) 또는 날짜 및 시간(YYYY-MM-DDTHHSSZ)을 허용합니다. 날짜만 제공된 경우 시스템에서는 해당 날짜의 자정(UTC, 00:00:00Z)을 사용합니다. 만료 은(는) 적어도 24시간 이후여야 합니다.API 형식
PUT /ttl/{DATASET_EXPIRATION_ID}
{DATASET_EXPIRATION_ID}
ttlId
(으)로 참조합니다.요청
다음 요청은 데이터 세트 만료 SD-c1f902aa-57cb-412e-bb2b-c70b8e1a5f45
에 대한 만료, 표시 이름 및 설명을 업데이트합니다.
curl -X PUT \
https://platform.adobe.io/data/core/hygiene/ttl/SD-c1f902aa-57cb-412e-bb2b-c70b8e1a5f45 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"displayName": "Customer Dataset Expiry Rule",
"description": "Updated description for Acme customer dataset",
"expiry": "2031-06-15"
}'
displayName
description
expiry
응답
성공적인 응답은 HTTP 상태 200(OK)과 업데이트된 데이터 세트 만료 구성을 반환합니다.
{
"ttlId": "SD-c1f902aa-57cb-412e-bb2b-c70b8e1a5f45",
"datasetId": "3e9f815ae1194c65b2a4c5ea",
"datasetName": "Acme_Customer_Data",
"sandboxName": "acme-prod",
"displayName": "Customer Dataset Expiry Rule",
"description": "Updated description for Acme customer dataset",
"imsOrg": "C9D8E7F6A5B41234567890AB@AcmeOrg",
"status": "pending",
"expiry": "2031-06-15T00:00:00Z",
"updatedAt": "2031-05-01T14:11:12.000Z",
"updatedBy": "b.tarth@acme.com <b.tarth@acme.com> 3E9F815AE1194C65B2A4C5EA@acme.com"
}
ttlId
datasetId
datasetName
sandboxName
displayName
description
imsOrg
status
하나:
pending
, executing
, cancelled
, completed
.expiry
updatedAt
updatedBy
실패한 응답은 그러한 데이터 세트 만료가 존재하지 않는 경우 404(찾을 수 없음) HTTP 상태를 반환합니다.
데이터 세트 만료 취소 delete
/ttl/{ID}
에 DELETE을 요청하여 보류 중인 데이터 집합 만료 구성을 취소하십시오.
pending
상태의 데이터 세트 만료만 취소할 수 있습니다. 이미 executing
, completed
또는 cancelled
인 만료를 취소하려고 하면 HTTP 400(잘못된 요청)이 반환됩니다.API 형식
DELETE /ttl/{ID}
{ID}
요청
다음 요청은 ID가 SD-d4a7d918-283b-41fd-bfe1-4e730a613d21
인 데이터 세트 만료를 취소합니다.
curl -X DELETE \
https://platform.adobe.io/data/core/hygiene/ttl/SD-d4a7d918-283b-41fd-bfe1-4e730a613d21 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
응답
성공한 응답은 HTTP 상태 200(OK)과 취소된 데이터 세트 만료 구성을 반환합니다. 만료의 status
특성이 cancelled
(으)로 설정되어 있지 않습니다.
{
"ttlId": "SD-d4a7d918-283b-41fd-bfe1-4e730a613d21",
"datasetId": "5a9e2c68d3b24f03b55a91ce",
"datasetName": "Acme_Customer_Data",
"sandboxName": "acme-prod",
"displayName": "Customer Dataset Expiry Rule",
"description": "Cancelled expiry configuration for Acme customer dataset",
"imsOrg": "C9D8E7F6A5B41234567890AB@AcmeOrg",
"status": "cancelled",
"expiry": "2032-02-28T00:00:00Z",
"updatedAt": "2032-01-15T08:27:31.000Z",
"updatedBy": "s.clegane@acme.com <s.clegane@acme.com> 5A9E2C68D3B24F03B55A91CE@acme.com"
}
ttlId
datasetId
datasetName
sandboxName
displayName
description
imsOrg
status
하나:
pending
, executing
, cancelled
, completed
.expiry
updatedAt
updatedBy
예제 400(잘못된 요청) 응답
executing
, completed
또는 cancelled
만료 구성이 있는 데이터 집합을 취소하려고 하면 400 오류가 발생합니다.
{
"type": "http://ns.adobe.com/aep/errors/HYGN-3102-400",
"title": "The requested dataset already has an existing expiration. Additional detail: A TTL already exists for datasetId=686e9ca25ef7462aefe72c93",
"status": 400,
"report": {
"tenantInfo": {
"sandboxName": "prod",
"sandboxId": "not-applicable",
"imsOrgId": "{IMS_ORG_ID}"
},
"additionalContext": {
"Invoking Client ID": "acp_privacy_hygiene"
}
},
"error-chain": [
{
"serviceId": "HYGN",
"errorCode": "HYGN-3102-400",
"invokingServiceId": "acp_privacy_hygiene",
"unixTimeStampMs": 1754408150394
}
]
}
completed
또는 cancelled
인 데이터 집합 만료를 취소하려고 하면 404 오류가 발생합니다.부록
수락된 쿼리 매개 변수 query-params
다음 표에서는 데이터 세트 만료를 나열할 때 사용할 수 있는 쿼리 매개 변수에 대해 설명합니다.
description
, displayName
및 datasetName
매개 변수에는 모두 LIKE 값으로 검색하는 기능이 포함되어 있습니다. 즉, 문자열 "Name1"을 검색하여 "Name123", "Name183", "DisplayName1234"라는 예약된 데이터 세트 만료를 찾을 수 있습니다.author
author
쿼리 매개 변수를 사용하여 데이터 세트 만료를 가장 최근에 업데이트한 사람을 찾으십시오. 생성 후 업데이트가 없는 경우 만료의 원래 생성자와 일치합니다. 이 매개 변수는 created_by
필드가 검색 문자열에 해당하는 만료와 일치합니다.검색 문자열이
LIKE
또는 NOT LIKE
(으)로 시작하는 경우 나머지는 SQL 검색 패턴으로 처리됩니다. 그렇지 않으면 전체 검색 문자열은 created_by
필드의 전체 내용과 정확히 일치해야 하는 리터럴 문자열로 처리됩니다.author=LIKE %john%
, author=John Q. Public
datasetId
datasetId=62b3925ff20f8e1b990a7434
datasetName
datasetName=Acme
description
description=Handle expiration of Acme information through the end of 2024.
displayName
displayName=License Expiry
executedDate
/ executedFromDate
/ executedToDate
executedDate=2023-02-05T19:34:40.383615Z
expiryDate
2024-01-01
expiryToDate
/ expiryFromDate
expiryFromDate=2099-01-01&expiryToDate=2100-01-01
limit
limit=50
orderBy
orderBy
쿼리 매개 변수는 API에서 반환된 결과의 정렬 순서를 지정합니다. 하나 이상의 필드를 기준으로 데이터를 오름차순(ASC) 또는 내림차순(DESC) 순서로 정렬하는 데 사용합니다. ASC, DESC를 각각 지정하려면 + 또는 - 접두사를 사용하십시오. 허용되는 값은 displayName
, description
, datasetName
, id
, updatedBy
, updatedAt
, expiry
, status
입니다.-datasetName
orgId
x-gw-ims-org-id
헤더의 값으로 설정되며, 요청에서 서비스 토큰을 제공하지 않는 한 무시됩니다.orgId=885737B25DC460C50A49411B@AdobeOrg
page
page=3
sandboxName
x-sandbox-name
헤더에 있는 샌드박스 이름으로 기본 설정됩니다. sandboxName=*
을(를) 사용하여 모든 샌드박스에서 데이터 집합 만료를 포함하세요.sandboxName=dev1
search
지정된 문자열이 만료 ID와 정확히 일치하거나 다음 필드 중 하나에서 포함됨 인 만료와 일치합니다.
- 작성자
- 표시 이름
- 설명
- 표시 이름
- 데이터 세트 이름
search=TESTING
status
status=pending,cancelled
ttlId
ttlID=SD-c8c75921-2416-4be7-9cfd-9ab01de66c5f
updatedDate
2024-01-01
updatedToDate
/ updatedFromDate
만료를 만들거나 취소하거나 실행할 때를 포함하여 모든 편집 시 만료를 업데이트한 것으로 간주합니다.
updatedDate=2022-01-01