API에서 데이터 사용 정책 만들기

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

이 문서에서는 Policy Service API. API에서 사용할 수 있는 다양한 작업에 대한 보다 포괄적인 안내서는 를 참조하십시오. 정책 서비스 개발자 안내서.

시작하기

이 자습서에서는 정책 만들기 및 평가와 관련된 다음 주요 개념을 실무적으로 이해해야 합니다.

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

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

마케팅 작업 정의

데이터 거버넌스 프레임워크에서 마케팅 작업은 다음과 같은 작업입니다 Experience Platform 데이터 소비자는 데이터 사용 정책을 위반하는 사항을 확인해야 합니다.

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

기존 마케팅 작업 조회

다음 중 하나에 대한 GET 요청을 만들어 정책에 의해 평가될 기존 마케팅 작업을 조회할 수 있습니다 /marketingActions 엔드포인트.

API 형식

에서 제공하는 마케팅 작업을 조회하는지 여부에 따라 Experience Platform 또는 조직에서 만든 사용자 지정 마케팅 작업에서 marketingActions/core 또는 marketingActions/custom 엔드포인트.

GET /marketingActions/core
GET /marketingActions/custom

요청

다음 요청에서는 marketingActions/custom IMS 조직에서 정의한 모든 마케팅 작업 목록을 가져오는 종단점입니다.

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 속성을 사용합니다. 이 값은 정책 만들기.

새 마케팅 작업 만들기

에 PUT 요청을 만들어 새 마케팅 작업을 만들 수 있습니다 /marketingActions/custom/ 엔드포인트 및 요청 경로 끝에 마케팅 작업 이름을 제공합니다.

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를 기록합니다.

정책 만들기

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

이 식을 정책 표현식이라고 하며, (A) 레이블 또는 (B) 연산자와 피연산자를 포함하지만 둘 다 포함하는 객체입니다. 그러면 각 피연산자가 정책 표현식 개체이기도 합니다. 예를 들어, 다음의 경우 데이터를 제3자에게 내보내는 정책을 금지할 수 있습니다 C1 OR (C3 AND C7) 레이블이 있습니다. 이 표현식은 다음과 같이 지정됩니다.

"deny": {
  "operator": "OR",
  "operands": [
    {
      "label": "C1"
    },
    {
      "operator": "AND",
      "operands": [
        {
          "label": "C3"
        },
        {
          "label": "C7"
        }
      ]
    }
  ]
}
노트

OR 및 AND 연산자만 지원됩니다.

정책 표현식을 구성한 후에는 /policies/custom 엔드포인트.

API 형식

POST /policies/custom

요청

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

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를 기록합니다.

정책 활성화

노트

이 단계는 정책을 DRAFT 상태는 기본적으로 정책의 상태가 ENABLED 평가에 참여하기 위해서. 다음 안내서를 참조하십시오. 정책 시행 의 정책에 대한 예외를 만드는 방법에 대한 자세한 정보 DRAFT 상태.

기본적으로 정책이 있는 정책 status 속성 설정 DRAFT 평가에 관여하지 마십시오. 에 PATCH 요청을 수행하여 평가를 위한 정책을 활성화할 수 있습니다 /policies/custom/ endpoint 및 요청 경로 끝에 정책에 대한 고유 식별자를 제공합니다.

API 형식

PATCH /policies/custom/{POLICY_ID}
매개 변수 설명
{POLICY_ID} 다음 id 활성화할 정책의 값입니다.

요청

다음 요청에서는 status 정책의 속성, 정책의 값 변경 DRAFT to 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 작업 유형입니다. 이 요청은 "replace" 작업을 수행합니다.
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"
}

다음 단계

이 자습서를 따라 마케팅 작업에 대한 데이터 사용 정책을 만들었습니다. 이제 의 자습서를 계속 진행할 수 있습니다. 데이터 사용 정책 적용 정책 위반을 확인하고 experience 애플리케이션에서 처리하는 방법을 알아봅니다.

에서 사용 가능한 여러 작업에 대한 자세한 내용은 Policy Service API인 경우 정책 서비스 개발자 안내서. 에 대한 정책 적용 방법에 대한 자세한 정보 Real-time Customer Profile 데이터는에서 자습서를 참조하십시오. 대상 세그먼트에 대한 데이터 사용 규정 준수 적용.

에서 사용 정책을 관리하는 방법을 알아봅니다. Experience Platform 사용자 인터페이스의 경우 정책 사용 안내서.

이 페이지에서는