使用Policy Service API强制实施数据使用策略

为数据创建数据使用标签并针对这些标签创建市场营销操作的使用策略后,您可以使用Policy Service API评估对数据集或任意标签组执行的市场营销操作是否构成策略违规。 然后,您可以设置自己的内部协议,以根据API响应处理策略违规。

注意

默认情况下,只有状态设置为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} 用于测试其营销操作的数据使用标签。 必须提供至少一个标签。 提供多个标签时,必须用逗号分隔。

请求

以下请求针对标签C1C3测试exportToThirdParty营销操作。 由于您在本教程前面创建的数据使用策略将C1标签定义为其策略表达式中的deny条件之一,因此营销操作应触发策略违规。

注意

数据使用标签区分大小写。 只有在策略表达式中定义的标签完全匹配时,才会发生策略违规。 在此示例中,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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

响应

成功的响应返回营销操作的URL、测试所针对的使用标签,以及针对这些标签测试操作而违反的任何策略的列表。 在此示例中,violatedPolicies阵列中显示“将数据导出到第三方”策略,指示营销操作触发了预期的策略违规。

{
    "timestamp": 1565727821209,
    "clientId": "string",
    "userId": "string",
    "imsOrg": "{IMS_ORG}",
    "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": "{IMS_ORG}",
            "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: {IMS_ORG}' \
  -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 Pointer字符串数组,引用数据集模式中的特定字段。 如果包含此数组,则只有数组中包含的字段参与评估。 数组中未包含的任何模式字段将不参与评估。

如果未包括此字段,则评估中将包括数据集模式中的所有字段。

响应

成功的响应会返回营销操作的URL、从提供的数据集收集的使用标签以及针对这些标签测试操作而违反的任何策略的列表。 在此示例中,violatedPolicies阵列中显示“将数据导出到第三方”策略,指示营销操作触发了预期的策略违规。

{
    "timestamp": 1556324277895,
    "clientId": "{CLIENT_ID}",
    "userId": "{USER_ID}",
    "imsOrg": "{IMS_ORG}",
    "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": "{IMS_ORG}",
            "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响应中返回的数据,您可以在体验应用程序中设置协议,以在发生策略违规时相应地强制实施这些违规。

有关平台如何为激活的区段自动提供策略强制的信息,请参阅自动强制上的指南。

在此页面上