설명서Experience PlatformData Governance 안내서

API에서 데이터 거버넌스 정책 만들기

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

작성 대상:

  • 사용자
  • 개발자
  • 관리자

정책 서비스 API를 사용하면 데이터 거버넌스 정책을 만들고 관리하여 특정 데이터 사용 레이블이 포함된 데이터에 대해 취할 수 있는 마케팅 작업을 결정할 수 있습니다.

이 문서에서는 Policy Service API를 사용하여 거버넌스 정책을 만드는 단계별 자습서를 제공합니다.

NOTE
액세스 제어 정책을 만드는 방법에 대한 단계는 액세스 제어 API에 대한 /policies 끝점 가이드를 참조하십시오. 동의 정책을 만드는 방법을 알아보려면 정책 UI 안내서를 참조하세요.

시작하기

이 자습서에서는 정책 생성 및 평가와 관련된 다음 주요 개념에 대한 작업 이해를 필요로 합니다.

  • Adobe Experience Platform 데이터 거버넌스: Platform에서 데이터 사용 규정 준수를 적용하는 프레임워크입니다.
    • 데이터 사용 레이블: 데이터 사용 레이블은 XDM 데이터 필드에 적용되며 데이터 액세스 방법에 대한 제한을 지정합니다.
  • Experience Data Model (XDM): Platform에서 고객 경험 데이터를 구성하는 표준화된 프레임워크입니다.
  • 샌드박스: Experience Platform에서는 단일 Platform 인스턴스를 별도의 가상 환경으로 분할하여 디지털 경험 응용 프로그램을 개발하고 발전시키는 데 도움이 되는 가상 샌드박스를 제공합니다.

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

마케팅 액션 정의 define-action

데이터 거버넌스 프레임워크에서 마케팅 액션은 Experience Platform 데이터 소비자가 수행하는 액션으로, 데이터 사용 정책 위반을 확인해야 합니다.

데이터 사용 정책을 만드는 첫 번째 단계는 정책이 평가할 마케팅 작업을 결정하는 것입니다. 이 작업은 다음 옵션 중 하나를 사용하여 수행할 수 있습니다.

기존 마케팅 액션 조회 look-up

/marketingActions 끝점 중 하나에 GET 요청을 하여 정책에서 평가할 기존 마케팅 작업을 조회할 수 있습니다.

API 형식

Experience Platform에서 제공하는 마케팅 작업을 조회하는지 또는 조직에서 만든 사용자 지정 마케팅 작업을 조회하고 있는지에 따라 각각 marketingActions/core 또는 marketingActions/custom 끝점을 사용합니다.

GET /marketingActions/core
GET /marketingActions/custom

요청

다음 요청은 marketingActions/custom 끝점을 사용하여 조직에서 정의한 모든 마케팅 작업 목록을 가져옵니다.

curl -X GET \
  https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/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}'

응답

성공한 응답은 찾은 총 마케팅 작업 수(count)를 반환하고 children 배열 내에 마케팅 작업 자체의 세부 정보를 나열합니다.

{
    "_page": {
        "start": "sampleMarketingAction",
        "count": 2
    },
    "_links": {
        "page": {
            "href": "https://platform.adobe.io/marketingActions/custom?{?limit,start,property}",
            "templated": true
        }
    },
    "children": [
        {
            "name": "sampleMarketingAction",
            "description": "Marketing Action description.",
            "imsOrg": "{ORG_ID}",
            "created": 1550714012088,
            "createdClient": "{CREATED_CLIENT}",
            "createdUser": "{CREATED_USER}",
            "updated": 1550714012088,
            "updatedClient": "{UPDATED_CLIENT}",
            "updatedUser": "{UPDATED_USER}",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/sampleMarketingAction"
                }
            }
        },
        {
            "name": "newMarketingAction",
            "description": "Another marketing action.",
            "imsOrg": "{ORG_ID}",
            "created": 1550793833224,
            "createdClient": "{CREATED_CLIENT}",
            "createdUser": "{CREATED_USER}",
            "updated": 1550793833224,
            "updatedClient": "{UPDATED_CLIENT}",
            "updatedUser": "{UPDATED_USER}",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/newMarketingAction"
                }
            }
        }
    ]
}
속성
설명
_links.self.href
children 배열 내의 각 항목에는 나열된 마케팅 작업에 대한 URI ID가 포함되어 있습니다.

사용할 마케팅 작업을 찾으면 해당 href 속성의 값을 기록합니다. 이 값은 정책을 만드는 중의 다음 단계에서 사용됩니다.

새 마케팅 액션 만들기 create-new

/marketingActions/custom/ 끝점에 PUT 요청을 하고 요청 경로 끝에 마케팅 작업의 이름을 제공하여 새 마케팅 작업을 만들 수 있습니다.

API 형식

PUT /marketingActions/custom/{MARKETING_ACTION_NAME}
매개변수
설명
{MARKETING_ACTION_NAME}
만들려는 새 마케팅 액션의 이름입니다. 이 이름은 마케팅 작업의 기본 식별자 역할을 하므로 고유해야 합니다. 가장 좋은 방법은 마케팅 액션에 설명적이지만 간결한 이름을 지정하는 것입니다.

요청

다음 요청은 "exportToThirdParty"라는 새 사용자 지정 마케팅 작업을 만듭니다. 요청 페이로드의 name이(가) 요청 경로에 제공된 이름과 동일합니다.

curl -X PUT \
  https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty \
  -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 '{
      "name": "exportToThirdParty",
      "description": "Export data to a third party"
    }'
속성
설명
name
만들려는 마케팅 액션의 이름입니다. 이 이름은 요청 경로에 제공된 이름과 일치해야 합니다. 그렇지 않으면 400(잘못된 요청) 오류가 발생합니다.
description
사람이 인식할 수 있는 마케팅 액션에 대한 설명입니다.

응답

성공적인 응답은 HTTP 상태 201(생성됨) 및 새로 생성된 마케팅 작업의 세부 정보를 반환합니다.

{
    "name": "exportToThirdParty",
    "description": "Export data to a third party",
    "imsOrg": "{ORG_ID}",
    "created": 1550713341915,
    "createdClient": "{CREATED_CLIENT}",
    "createdUser": "{CREATED_USER",
    "updated": 1550713856390,
    "updatedClient": "{UPDATED_CLIENT}",
    "updatedUser": "{UPDATED_USER}",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
        }
    }
}
속성
설명
_links.self.href
마케팅 액션의 URI ID입니다.

새로 만든 마케팅 작업의 URI ID를 기록합니다. 해당 ID는 정책을 만드는 다음 단계에서 사용됩니다.

정책 만들기 create-policy

새 정책을 만들려면 마케팅 작업을 금지하는 사용 레이블 표현식과 함께 마케팅 작업의 URI ID를 제공해야 합니다.

이 표현식을 정책 표현식이라고 하며 (A) 레이블 또는 (B) 연산자와 피연산자 중 하나를 포함하는 객체이지만 둘 다 포함하는 것은 아닙니다. 또한 각 피연산자는 정책 표현식 객체이기도 합니다. 예를 들어, C1 OR (C3 AND C7) 레이블이 있는 경우 데이터를 서드파티로 내보내는 것과 관련된 정책이 금지될 수 있습니다. 이 표현식은 다음과 같이 지정됩니다.

"deny": {
  "operator": "OR",
  "operands": [
    {
      "label": "C1"
    },
    {
      "operator": "AND",
      "operands": [
        {
          "label": "C3"
        },
        {
          "label": "C7"
        }
      ]
    }
  ]
}
NOTE
OR 및 AND 연산자만 지원됩니다.

정책 식을 구성했으면 /policies/custom 끝점에 대한 POST 요청을 하여 새 정책을 만들 수 있습니다.

API 형식

POST /policies/custom

요청

다음 요청은 요청 페이로드에 마케팅 작업과 정책 표현식을 제공하여 "데이터를 서드파티에 내보내기"라는 정책을 만듭니다.

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": [
      "../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"}
          ]
        }
      ]
    }
  }'
속성
설명
marketingActionRefs
이전 단계에서 얻은 마케팅 작업의 href 값을 포함하는 배열입니다. 위의 예에서는 마케팅 작업이 한 개만 나열되지만 여러 작업을 제공할 수도 있습니다.
deny
정책 표현식 객체입니다. 정책이 marketingActionRefs에서 참조한 마케팅 작업을 거부하도록 하는 사용 레이블 및 조건을 정의합니다.

응답

성공적인 응답은 HTTP 상태 201(생성됨) 및 새로 생성된 정책의 세부 사항을 반환합니다.

{
    "name": "Export Data to Third Party",
    "status": "DRAFT",
    "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": 1565651746693,
    "updatedClient": "{UPDATED_CLIENT}",
    "updatedUser": "{UPDATED_USER}",
    "_links": {
        "self": {
            "href": "https://platform-stage.adobe.io/data/foundation/dulepolicy/policies/custom/5d51f322e553c814e67af1a3"
        }
    },
    "id": "5d51f322e553c814e67af1a3"
}
속성
설명
id
정책을 고유하게 식별하는 읽기 전용, 시스템 생성 값입니다.

다음 단계에서 정책을 활성화하는 데 사용되므로 새로 만든 정책의 URI ID를 기록합니다.

정책 활성화

NOTE
정책을 DRAFT 상태로 유지하려면 이 단계는 선택 사항이지만 평가에 참여하려면 기본적으로 정책의 상태가 ENABLED(으)로 설정되어 있어야 합니다. DRAFT 상태에서 정책에 대한 예외를 만드는 방법에 대한 자세한 내용은 정책 적용에 대한 안내서를 참조하십시오.

기본적으로 status 속성이 DRAFT(으)로 설정된 정책은 평가에 참여하지 않습니다. /policies/custom/ 끝점에 대한 PATCH 요청을 만들고 요청 경로의 끝에 정책에 대한 고유 식별자를 제공하여 평가를 위해 정책을 사용하도록 설정할 수 있습니다.

API 형식

PATCH /policies/custom/{POLICY_ID}
매개변수
설명
{POLICY_ID}
사용할 정책의 id 값입니다.

요청

다음 요청은 정책의 status 속성에 대해 PATCH 작업을 수행하여 해당 값을 DRAFT에서 ENABLED(으)로 변경합니다.

curl -X PATCH \
  https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5d51f322e553c814e67af1a3
  -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
수행할 PATCH 작업의 유형입니다. 이 요청은 "바꾸기" 작업을 수행합니다.
path
업데이트할 필드의 경로입니다. 정책을 활성화할 때 값을 "/status"로 설정해야 합니다.
value
path에 지정된 속성에 지정할 새 값입니다. 이 요청은 정책의 status 속성을 "ENABLED"로 설정합니다.

응답

성공한 응답은 HTTP 상태 200(OK)과 업데이트된 정책의 세부 정보를 반환하며 해당 status이(가) 이제 ENABLED(으)로 설정됩니다.

{
    "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"
}

다음 단계

이 자습서에 따라 마케팅 작업에 대한 데이터 사용 정책을 성공적으로 만들었습니다. 이제 데이터 사용 정책 적용에 대한 자습서를 계속 진행하여 정책 위반을 확인하고 경험 애플리케이션에서 처리하는 방법을 배울 수 있습니다.

Policy Service API에서 사용할 수 있는 다양한 작업에 대한 자세한 내용은 정책 서비스 개발자 안내서를 참조하십시오. Real-Time Customer Profile 데이터에 정책을 적용하는 방법에 대한 자세한 내용은 대상 세그먼트에 대한 데이터 사용 규정 준수 적용에 대한 자습서를 참조하십시오.

Experience Platform 사용자 인터페이스에서 사용 정책을 관리하는 방법을 알아보려면 정책 사용 안내서를 참조하세요.

recommendation-more-help
834e0cae-2761-454a-be4d-62f0fd4b4456