文档 Experience Platform Data Governance 指南

使用Policy Service API强制执行数据使用策略

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

主题：
数据管理

创建对象：

用户
开发人员
管理员

一旦您为数据创建了数据使用标签，并针对这些标签创建了营销操作的使用策略，您就可以使用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}

用于测试营销操作的数据使用标签。必须至少提供一个标签。提供多个标签时，必须使用逗号分隔。

请求

以下请求根据标签C1和C3测试exportToThirdParty营销操作。由于您之前在本教程中创建的数据使用策略将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

一个数组，列出了通过针对提供的duleLabels测试营销操作（在marketingActionRef中指定）而违反的任何策略。

使用数据集进行评估

您可以通过针对可从中收集标签的一个或多个数据集测试营销操作，来评估数据使用策略。这是通过对/marketingActions/core/{MARKETING_ACTION_NAME}/constraints发出POST请求并在请求正文中提供数据集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

一个数组，列出了通过针对提供的duleLabels测试营销操作（在marketingActionRef中指定）而违反的任何策略。

后续步骤

通过阅读本文档，您已经在对数据集或一组数据使用标签执行营销操作时成功检查了策略违规。使用API响应中返回的数据，您可以在体验应用程序中设置协议，以在发生策略违规时适当地实施这些违规。

有关Platform如何自动为激活的区段提供策略实施的信息，请参阅自动实施指南。

recommendation-more-help

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