데이터 거버넌스 정책 끝점
데이터 거버넌스 정책은 내 데이터 수행을 허용하거나 제한하는 마케팅 작업 종류를 설명하는 규칙입니다 Experience Platform. 다음 /policies
의 엔드포인트 Policy Service API 를 사용하면 조직의 데이터 거버넌스 정책을 프로그래밍 방식으로 관리할 수 있습니다.
/policies
에 대한 엔드포인트 가이드 액세스 제어 API 액세스 제어 정책을 프로그래밍 방식으로 관리하는 방법에 대한 자세한 내용을 보려면 여기를 클릭하십시오.시작하기
이 안내서에 사용된 API 끝점은 Policy Service API. 계속하기 전에 다음을 검토하십시오. 시작 안내서 관련 설명서에 대한 링크, 이 문서에서 샘플 API 호출 읽기에 대한 안내서 및 를 성공적으로 호출하는 데 필요한 필수 헤더에 대한 중요 정보 Experience Platform API.
정책 목록 검색 list
모두 나열할 수 있습니다. core
또는 custom
에 GET 요청을 하여 정책 /policies/core
또는 /policies/custom
, 각각
API 형식
GET /policies/core
GET /policies/custom
요청
다음 요청은 조직에서 정의한 사용자 지정 정책 목록을 검색합니다.
curl -X GET \
https://platform.adobe.io/data/foundation/dulepolicy/policies/custom \
-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}'
응답
성공적인 응답에는 다음이 포함됩니다. children
검색된 각 정책에 대한 세부 정보를 나열하는 배열입니다. id
값. 다음을 사용할 수 있습니다. id
수행할 특정 정책의 필드 조회, 업데이트, 및 삭제 해당 정책에 대한 요청입니다.
{
"_page": {
"start": "5c6dacdf685a4913dc48937c",
"count": 2
},
"_links": {
"page": {
"href": "https://platform.adobe.io/policies/custom?{?limit,start,property}",
"templated": true
}
},
"children": [
{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "AND",
"operands": [
{
"label": "C1"
},
{
"operator": "OR",
"operands": [
{
"label": "C3"
},
{
"label": "C7"
}
]
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550691551888,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550701472910,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
}
},
"id": "5c6dacdf685a4913dc48937c"
},
{
"name": "Combine Data",
"status": "ENABLED",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/combineData"
],
"description": "Data that meets these conditions cannot be combined.",
"deny": {
"operator": "AND",
"operands": [
{
"label": "C3"
},
{
"label": "I1"
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550703519823,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550714340335,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6ddb9f5c404513dc2dc454"
}
},
"id": "5c6ddb9f5c404513dc2dc454"
}
]
}
_page.count
name
status
DRAFT
, ENABLED
, 또는 DISABLED
. 기본적으로 만 ENABLED
정책은 평가에 참여합니다. 의 개요 보기 정책 평가 추가 정보.marketingActionRefs
description
deny
정책 조회 look-up
해당 정책을 포함하여 특정 정책을 조회할 수 있습니다. id
GET 요청 경로에 있는 속성입니다.
API 형식
GET /policies/core/{POLICY_ID}
GET /policies/custom/{POLICY_ID}
{POLICY_ID}
id
조회하려는 정책.요청
curl -X GET \
https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c \
-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}'
응답
성공한 응답은 정책의 세부 정보를 반환합니다.
{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "AND",
"operands": [
{
"label": "C1"
},
{
"operator": "OR",
"operands": [
{
"label": "C3"
},
{
"label": "C7"
}
]
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550703519823,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550714340335,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
}
},
"id": "5c6dacdf685a4913dc48937c"
}
name
status
DRAFT
, ENABLED
, 또는 DISABLED
. 기본적으로 만 ENABLED
정책은 평가에 참여합니다. 의 개요 보기 정책 평가 추가 정보.marketingActionRefs
description
deny
사용자 지정 정책 만들기 create-policy
다음에서 Policy Service API에서 정책은 다음과 같이 정의됩니다.
- 특정 마케팅 작업에 대한 참조
- 마케팅 작업이 수행되는 것이 제한되는 데이터 사용 레이블을 설명하는 표현식
후자의 요구 사항을 충족하려면 정책 정의에 데이터 사용 레이블의 존재에 대한 부울 표현식이 포함되어야 합니다. 이 표현식을 정책 표현식이라고 합니다.
정책 표현식은 deny
각 정책 정의 내의 속성입니다. 간단한 예 deny
단일 레이블이 있는지 여부만 확인하는 객체는 다음과 같습니다.
"deny": {
"label": "C1"
}
그러나 많은 정책이 데이터 사용 레이블의 존재와 관련하여 보다 복잡한 조건을 지정합니다. 이러한 사용 사례를 지원하기 위해 정책 표현식을 설명하는 부울 작업을 포함할 수도 있습니다. 정책 표현식 객체에는 레이블이나 연산자 및 피연산자가 포함되어야 하지만 둘 다 포함되어서는 안 됩니다. 또한 각 피연산자는 정책 표현식 객체이기도 합니다.
예를 들어, 다음 위치에서 데이터에 대한 마케팅 작업을 수행할 수 없도록 하는 정책을 정의하기 위해 C1 OR (C3 AND C7)
레이블이 있고 정책의 deny
속성은 다음과 같이 지정됩니다.
"deny": {
"operator": "OR",
"operands": [
{"label": "C1"},
{
"operator": "AND",
"operands": [
{"label": "C3"},
{"label": "C7"}
]
}
]
}
operator
동위 멤버에 제공된 레이블 간의 조건부 관계를 나타냅니다. operands
배열입니다. 허용되는 값은 다음과 같습니다.
OR
: 다음 내에 레이블이 하나라도 있으면 표현식이 true로 확인됩니다.operands
배열이 있습니다.AND
: 표현식은 의 모든 레이블이 true인 경우에만operands
배열이 있습니다.
operands
operator
및 operands
속성. 의 레이블 및/또는 작업 유무 operands
배열은 형제 값을 기준으로 true 또는 false로 확인됩니다. operator
속성.label
에 POST 요청을 하여 새 사용자 지정 정책을 만들 수 있습니다. /policies/custom
엔드포인트.
API 형식
POST /policies/custom
요청
다음 요청은 마케팅 액션을 제한하는 새 정책을 만듭니다 exportToThirdParty
레이블이 포함된 데이터에 대해 수행되는 작업 C1 OR (C3 AND C7)
.
curl -X POST \
https://platform.adobe.io/data/foundation/dulepolicy/policies/custom \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "OR",
"operands": [
{"label": "C1"},
{
"operator": "AND",
"operands": [
{"label": "C3"},
{"label": "C7"}
]
}
]
}
}'
name
status
DRAFT
, ENABLED
, 또는 DISABLED
. 기본적으로 만 ENABLED
정책은 평가에 참여합니다. 의 개요 보기 정책 평가 추가 정보.marketingActionRefs
_links.self.href
에 대한 응답으로 마케팅 액션 조회.description
deny
응답
응답이 성공하면 새로 만든 정책에 대한 세부 정보(예: id
. 이 값은 읽기 전용이며 정책이 생성될 때 자동으로 할당됩니다.
{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "OR",
"operands": [
{
"label": "C1"
},
{
"operator": "AND",
"operands": [
{
"label": "C3"
},
{
"label": "C7"
}
]
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550691551888,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550691551888,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
}
},
"id": "5c6dacdf685a4913dc48937c"
}
사용자 지정 정책 업데이트 update
정책 전체가 업데이트된 형식을 포함하는 페이로드와 함께 PUT 요청 경로에 ID를 제공하여 기존 사용자 지정 정책을 업데이트할 수 있습니다. 즉, PUT 요청은 본질적으로 정책을 재작성한다.
API 형식
PUT /policies/custom/{POLICY_ID}
{POLICY_ID}
id
업데이트할 정책요청
이 예에서는 데이터를 서드파티로 내보내는 조건이 변경되었으며, 이제는 다음과 같은 경우 이 마케팅 작업을 거부하기 위해 만든 정책이 필요합니다 C1 AND C5
데이터 레이블이 있습니다.
다음 요청은 새 정책 표현식을 포함하도록 기존 정책을 업데이트합니다. 이 요청은 본질적으로 정책을 재작성하므로 일부 값이 업데이트되지 않더라도 모든 필드는 페이로드에 포함해야 합니다.
curl -X PUT \
https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"../marketingActions/custom/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "AND",
"operands": [
{"label": "C1"},
{"label": "C5"}
]
}
}'
name
status
DRAFT
, ENABLED
, 또는 DISABLED
. 기본적으로 만 ENABLED
정책은 평가에 참여합니다. 의 개요 보기 정책 평가 추가 정보.marketingActionRefs
_links.self.href
에 대한 응답으로 마케팅 액션 조회.description
deny
응답
성공한 응답은 업데이트된 정책의 세부 정보를 반환합니다.
{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/core/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "AND",
"operands": [
{
"label": "C1"
},
{
"label": "C5"
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550691551888,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550701472910,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
}
},
"id": "5c6dacdf685a4913dc48937c"
}
사용자 지정 정책의 일부 업데이트 patch
정책의 특정 부분은 PATCH 요청을 사용하여 업데이트될 수 있다. 정책을 다시 작성하는 PUT 요청과 달리, PATCH 요청은 요청 본문에 지정된 속성만 업데이트합니다. 이 기능은 적절한 속성( )에 대한 경로만 제공하면 되므로 정책을 활성화하거나 비활성화하려는 경우에 특히 유용합니다./status
) 및 그 값(ENABLED
또는 DISABLED
).
다음 Policy Service API는 JSON 패치 작업을 지원합니다. add
, remove
, 및 replace
을 사용하면 아래 예에 표시된 대로 여러 업데이트를 하나의 호출로 결합할 수 있습니다.
API 형식
PATCH /policies/custom/{POLICY_ID}
{POLICY_ID}
id
속성을 업데이트할 정책.요청
다음 요청은 두 개를 사용합니다 replace
정책 상태를 변경할 작업 DRAFT
끝 ENABLED
, 및 를 업데이트하여 description
새 설명이 있는 필드.
curl -X PATCH \
https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d ' [
{
"op": "replace",
"path": "/status",
"value": "ENABLED"
},
{
"op": "replace",
"path": "/description",
"value": "New policy description."
}
]'
응답
성공한 응답은 업데이트된 정책의 세부 정보를 반환합니다.
{
"name": "Export Data to Third Party",
"status": "ENABLED",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
],
"description": "New policy description.",
"deny": {
"operator": "AND",
"operands": [
{
"label": "C1"
},
{
"operator": "OR",
"operands": [
{
"label": "C3"
},
{
"label": "C7"
}
]
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550703519823,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550712163182,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
}
},
"id": "5c6dacdf685a4913dc48937c"
}
사용자 지정 정책 삭제 delete
다음을 포함하여 사용자 지정 정책을 삭제할 수 있습니다. id
DELETE 요청의 경로에 있습니다.
API 형식
DELETE /policies/custom/{POLICY_ID}
{POLICY_ID}
요청
curl -X DELETE \
https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6ddb56eb60ca13dbf8b9a8 \
-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)을 반환합니다.
정책을 다시 조회(GET)하여 삭제를 확인할 수 있습니다. 정책이 성공적으로 삭제되면 HTTP 404(찾을 수 없음) 오류가 표시됩니다.
활성화된 핵심 정책 목록 검색 list-enabled-core
기본적으로 활성화된 데이터 거버넌스 정책만 평가에 참여합니다. 에 GET 요청을 하여 조직에서 현재 활성화된 핵심 정책 목록을 검색할 수 있습니다. /enabledCorePolicies
엔드포인트.
API 형식
GET /enabledCorePolicies
요청
curl -X GET \
https://platform.adobe.io/data/foundation/dulepolicy/enabledCorePolicies \
-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}'
응답
성공적인 응답은 아래 활성화된 핵심 정책 목록을 반환합니다. policyIds
배열입니다.
{
"policyIds": [
"corepolicy_0001",
"corepolicy_0002",
"corepolicy_0003",
"corepolicy_0004",
"corepolicy_0005",
"corepolicy_0006",
"corepolicy_0007",
"corepolicy_0008"
],
"imsOrg": "{ORG_ID}",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/enabledCorePolicies"
}
}
}
활성화된 핵심 정책 목록 업데이트 update-enabled-core
기본적으로 활성화된 데이터 거버넌스 정책만 평가에 참여합니다. 에 PUT 요청 수행 /enabledCorePolicies
엔드포인트에서는 한 번의 호출로 조직에 대해 활성화된 핵심 정책 목록을 업데이트할 수 있습니다.
API 형식
PUT /enabledCorePolicies
요청
다음 요청은 페이로드에 제공된 ID를 기반으로 활성화된 핵심 정책 목록을 업데이트합니다.
curl -X GET \
https://platform.adobe.io/data/foundation/dulepolicy/enabledCorePolicies \
-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}' \
-d '{
"policyIds": [
"corepolicy_0001",
"corepolicy_0002",
"corepolicy_0007",
"corepolicy_0008"
]
}'
policyIds
DISABLED
상태 및 은(는) 평가에 참여하지 않습니다.응답
성공적인 응답은 아래 활성화된 핵심 정책의 업데이트된 목록을 반환합니다. policyIds
배열입니다.
{
"policyIds": [
"corepolicy_0001",
"corepolicy_0002",
"corepolicy_0007",
"corepolicy_0008"
],
"imsOrg": "{ORG_ID}",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1595876052649,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/enabledCorePolicies"
}
}
}
다음 단계
새 정책을 정의하거나 기존 정책을 업데이트한 후에는 Policy Service 특정 레이블 또는 데이터 세트에 대해 마케팅 작업을 테스트하고 정책이 예상대로 위반을 발생시키는지 여부를 확인하기 위한 API입니다. 에서 안내서 참조 정책 평가 엔드포인트 추가 정보.