설명서 Experience Platform Data Governance 안내서

다음을 사용하여 데이터 사용 정책 적용 Policy Service API

Last update: Wed May 24 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

주제:
Data Governance

작성 대상:

User
Developer
Admin

데이터에 대한 데이터 사용 레이블을 만들고 이러한 레이블에 대한 마케팅 작업에 대한 사용 정책을 만들면 다음을 사용할 수 있습니다. Policy Service API 데이터 세트 또는 임의의 레이블 그룹에 대해 수행된 마케팅 작업이 정책 위반을 구성하는지 여부를 평가합니다. 그런 다음 API 응답을 기반으로 정책 위반을 처리하도록 자체 내부 프로토콜을 설정할 수 있습니다.

NOTE

기본적으로 상태가 로 설정된 정책만 ENABLED 평가에 참여할 수 있습니다. 허용하려면 DRAFT 평가에 참여할 정책. 쿼리 매개 변수를 포함해야 합니다. includeDraft=true 요청 경로에서.

이 문서에서는 Policy Service 다른 시나리오에서 정책 위반을 확인하기 위한 API입니다.

시작하기

이 자습서에서는 데이터 사용 정책을 적용하는 데 관련된 다음 주요 개념을 이해해야 합니다.

데이터 거버넌스: 다음에 사용되는 프레임워크 Platform 데이터 사용 규정 준수를 시행합니다.
- 데이터 사용 레이블: 데이터 사용 레이블은 데이터 세트(및/또는 해당 데이터 세트 내의 개별 필드)에 적용되며, 데이터 사용 방법에 대한 제한을 지정합니다.
- 데이터 사용 정책: 데이터 사용 정책은 특정 데이터 사용 레이블 집합에 대해 허용되거나 제한되는 마케팅 작업 종류를 설명하는 규칙입니다.
샌드박스: Experience Platform 단일 파티션을 만드는 가상 샌드박스를 제공합니다. Platform 인스턴스를 별도의 가상 환경으로 전환하여 디지털 경험 애플리케이션을 개발하고 발전시킵니다.

이 자습서를 시작하기 전에 다음을 검토하십시오. 개발자 안내서 를 성공적으로 호출하기 위해 알아야 하는 중요한 정보 Policy Service 필수 헤더와 예제 API 호출을 읽는 방법을 포함한 API.

레이블 및 마케팅 액션을 사용하여 평가

데이터 세트 내에 가정적으로 존재하는 데이터 사용 레이블 세트에 대해 마케팅 작업을 테스트하여 정책을 평가할 수 있습니다. 이 작업은 다음을 사용하여 수행됩니다. duleLabels 쿼리 매개 변수. 여기서 레이블은 아래 예와 같이 쉼표로 구분된 값 목록으로 제공됩니다.

API 형식

GET /marketingActions/core/{MARKETING_ACTION_NAME}/constraints?duleLabels={LABEL_1},{LABEL_2}
GET /marketingActions/custom/{MARKETING_ACTION_NAME}/constraints?duleLabels={LABEL_1},{LABEL_2}

매개변수

설명

{MARKETING_ACTION_NAME}

평가 중인 데이터 사용 정책과 연결된 마케팅 작업의 이름입니다.

{LABEL_1}

마케팅 작업을 테스트할 데이터 사용 레이블. 레이블을 하나 이상 제공해야 합니다. 여러 레이블을 제공할 때는 쉼표로 구분해야 합니다.

요청

다음 요청은 exportToThirdParty 레이블에 대한 마케팅 액션 C1 및 C3. 이 자습서에서 이전에 만든 데이터 사용 정책은 C1 을(를) 다음 중 하나로 레이블 deny 정책 표현식에서 마케팅 작업은 정책 위반을 트리거해야 합니다.

NOTE

데이터 사용 레이블은 대/소문자를 구분합니다. 정책 위반은 해당 정책 표현식에 정의된 레이블이 정확하게 일치하는 경우에만 발생합니다. 이 예에서는 C1 레이블은 위반을 트리거하지만 c1 레이블은 그렇지 않습니다.

curl -X GET \
  https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty/constraints?duleLabels=C1,C3 \
  -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}'

응답

성공적인 응답은 마케팅 작업에 대한 URL, 테스트된 사용 레이블 및 해당 레이블에 대해 작업을 테스트한 결과 위반된 정책 목록을 반환합니다. 이 예에서는 "서드파티로 데이터 내보내기" 정책이 violatedPolicies 마케팅 작업이 예상 정책 위반을 트리거했음을 나타내는 배열입니다.

{
    "timestamp": 1565727821209,
    "clientId": "string",
    "userId": "string",
    "imsOrg": "{ORG_ID}",
    "marketingActionRef": "https://platform-stage.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty",
    "duleLabels": [
        "C1",
        "C3"
    ],
    "violatedPolicies": [
        {
            "name": "Export Data to Third Party",
            "status": "ENABLED",
            "marketingActionRefs": [
                "https://platform-stage.adobe.io:443/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": 1565651746693,
            "createdClient": "{CREATED_CLIENT}",
            "createdUser": "{CREATED_USER",
            "updated": 1565723012139,
            "updatedClient": "{UPDATED_CLIENT}",
            "updatedUser": "{UPDATED_USER}",
            "_links": {
                "self": {
                    "href": "https://platform-stage.adobe.io/data/foundation/dulepolicy/policies/custom/5d51f322e553c814e67af1a3"
                }
            },
            "id": "5d51f322e553c814e67af1a3"
        }
    ]
}

속성

설명

violatedPolicies

마케팅 작업을 테스트하여 위반된 정책을 나열하는 배열(에 지정됨) marketingActionRef제공된 에 대해 ) duleLabels.

데이터 세트 사용 평가

레이블을 수집할 수 있는 하나 이상의 데이터 세트에 대한 마케팅 작업을 테스트하여 데이터 사용 정책을 평가할 수 있습니다. 이 작업은 (으)로 POST 요청을 함으로써 수행됩니다. /marketingActions/core/{MARKETING_ACTION_NAME}/constraints 아래 예와 같이, 요청 본문 내에 데이터 세트 ID를 제공합니다.

API 형식

POST /marketingActions/core/{MARKETING_ACTION_NAME}/constraints
POST /marketingActions/custom/{MARKETING_ACTION_NAME}/constraints

매개변수

설명

{MARKETING_ACTION_NAME}

평가 중인 정책과 연관된 마케팅 작업의 이름입니다.

요청

다음 요청은 exportToThirdParty 세 개의 다른 데이터 세트에 대한 마케팅 액션. 데이터 세트는 페이로드에 제공된 배열의 유형 및 ID에 의해 참조됩니다.

curl -X POST \
  https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty/constraints
  -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 '[
    {
      "entityType": "dataSet",
      "entityId": "5c423dc25f2f2e00005e2319"
    },
    {
      "entityType": "dataSet",
      "entityId": "5cc323e15410ef14b749481e"
    },
    {
      "entityType": "dataSet",
      "entityId": "5cc1fb685410ef14b748c55f",
      "entityMeta": {
          "fields": [
              "/properties/personalEmail/properties/address",
              "/properties/person/properties/name/properties/fullName"
          ]
      }
    }
  ]'

속성

설명

entityType

페이로드 배열의 각 항목은 정의할 엔티티 유형을 나타내야 합니다. 이 사용 사례의 경우 값은 항상 "dataSet"입니다.

entityId

페이로드 배열의 각 항목은 데이터 세트에 대한 고유 ID를 제공해야 합니다.

entityMeta.fields

(선택 사항) 배열 JSON 포인터 문자열, 데이터 세트 스키마의 특정 필드 참조 이 배열이 포함된 경우 배열에 포함된 필드만 평가에 참여합니다. 배열에 포함되지 않은 모든 스키마 필드는 평가에 참여하지 않습니다.

이 필드가 포함되지 않으면 데이터 세트 스키마 내의 모든 필드가 평가에 포함됩니다.

응답

성공적인 응답은 마케팅 작업에 대한 URL, 제공된 데이터 세트에서 수집된 사용 레이블 및 해당 레이블에 대해 작업을 테스트한 결과 위반된 정책 목록을 반환합니다. 이 예에서는 "서드파티로 데이터 내보내기" 정책이 violatedPolicies 마케팅 작업이 예상 정책 위반을 트리거했음을 나타내는 배열입니다.

{
    "timestamp": 1556324277895,
    "clientId": "{CLIENT_ID}",
    "userId": "{USER_ID}",
    "imsOrg": "{ORG_ID}",
    "marketingActionRef": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty",
    "duleLabels": [
        "C1",
        "C2",
        "C4",
        "C5",
        "C6"
    ],
    "discoveredLabels": [
        {
            "entityType": "dataSet",
            "entityId": "5c423dc25f2f2e00005e2319",
            "dataSetLabels": {
                "connection": {
                    "labels": []
                },
                "dataSet": {
                    "labels": [
                        "C6"
                    ]
                },
                "fields": [
                    {
                        "labels": [
                            "C2",
                            "C5"
                        ],
                        "path": "/properties/_customer"
                    },
                    {
                        "labels": [
                            "C4",
                            "C5"
                        ],
                        "path": "/properties/geoUnit"
                    },
                    {
                        "labels": [
                            "C4"
                        ],
                        "path": "/properties/identityMap"
                    },
                    {
                        "labels": [
                            "C4"
                        ],
                        "path": "/properties/journeyAI"
                    },
                    {
                        "labels": [
                            "C5"
                        ],
                        "path": "/properties/createdByBatchID"
                    },
                    {
                        "labels": [
                            "C5"
                        ],
                        "path": "/properties/faxPhone"
                    }
                ]
            }
        },
        {
            "entityType": "dataSet",
            "entityId": "5cc323e15410ef14b749481e",
            "dataSetLabels": {
                "connection": {
                    "labels": []
                },
                "dataSet": {
                    "labels": [
                        "C5"
                    ]
                },
                "fields": [
                    {
                        "labels": [
                            "C2",
                        ],
                        "path": "/properties/_customer"
                    },
                    {
                        "labels": [
                            "C5"
                        ],
                        "path": "/properties/geoUnit"
                    },
                    {
                        "labels": [
                            "C1"
                        ],
                        "path": "/properties/identityMap"
                    }
                ]
            }
        },
        {
            "entityType": "dataSet",
            "entityId": "5cc1fb685410ef14b748c55f",
            "dataSetLabels": {
                "connection": {
                    "labels": []
                },
                "dataSet": {
                    "labels": [
                        "C5"
                    ]
                },
                "fields": [
                    {
                        "labels": [
                            "C5"
                        ],
                        "path": "/properties/personalEmail/properties/address",
                    },
                    {
                        "labels": [
                            "C5"
                        ],
                        "path": "/properties/person/properties/name/properties/fullName"
                    }
                ]
            }
        }
    ],
    "violatedPolicies": [
        {
            "name": "Export Data to Third Party",
            "status": "ENABLED",
            "marketingActionRefs": [
                "https://platform-stage.adobe.io:443/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": 1565651746693,
            "createdClient": "{CREATED_CLIENT}",
            "createdUser": "{CREATED_USER",
            "updated": 1565723012139,
            "updatedClient": "{UPDATED_CLIENT}",
            "updatedUser": "{UPDATED_USER}",
            "_links": {
                "self": {
                    "href": "https://platform-stage.adobe.io/data/foundation/dulepolicy/policies/custom/5d51f322e553c814e67af1a3"
                }
            },
            "id": "5d51f322e553c814e67af1a3"
        }
    ]
}

속성

설명

duleLabels

요청 페이로드에 제공된 데이터 세트에서 추출된 데이터 사용 레이블 목록입니다.

discoveredLabels

요청 페이로드에 제공된 데이터 세트 목록으로, 각 페이로드에서 찾은 데이터 세트 수준 및 필드 수준 레이블을 표시합니다.

violatedPolicies

마케팅 작업을 테스트하여 위반된 정책을 나열하는 배열(에 지정됨) marketingActionRef제공된 에 대해 ) duleLabels.

다음 단계

이 문서를 읽고 데이터 세트 또는 데이터 사용 레이블 세트에 대한 마케팅 작업을 수행할 때 정책 위반을 성공적으로 확인했습니다. API 응답에서 반환된 데이터를 사용하여 경험 애플리케이션 내에 프로토콜을 설정하여 정책 위반이 발생할 때 적절하게 적용할 수 있습니다.

Platform에서 활성화된 세그먼트에 대한 정책 집행을 자동으로 제공하는 방법에 대한 자세한 내용은 의 안내서를 참조하십시오. 자동 적용.

recommendation-more-help

834e0cae-2761-454a-be4d-62f0fd4b4456