在API中创建数据治理策略
此 策略服务API 允许您创建和管理数据治理策略,以确定可以对包含特定数据使用标签的数据采取哪些营销行动。
本文档分步说明了如何使用,创建治理策略。 Policy Service API。
快速入门
本教程需要对创建和评估策略所涉及的以下关键概念有一定的了解:
- Adobe Experience Platform数据管理:用于执行操作的框架 Platform 强制执行数据使用合规性。
- 数据使用情况标签:数据使用标签应用于XDM数据字段,指定访问数据的限制。
- Experience Data Model (XDM):用于实现此目标的标准化框架 Platform 组织客户体验数据。
- 沙盒: Experience Platform 提供对单个进行分区的虚拟沙盒 Platform 将实例安装到单独的虚拟环境中,以帮助开发和改进数字体验应用程序。
在开始本教程之前,请查看 开发人员指南 如需了解成功调用 Policy Service API,包括所需的标头以及如何读取示例API调用。
定义营销活动 define-action
在数据治理框架中,营销行动是指 Experience Platform 数据使用者需要使用,为此,需要检查是否存在违反数据使用策略的情况。
创建数据使用策略的第一步是确定策略将评估什么营销操作。 可以使用以下选项之一完成此操作:
查找现有营销操作 look-up
您可以通过对以下项之一发出GET请求,查找要由策略评估的现有营销操作 /marketingActions
端点。
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
您可以通过向以下网站发出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
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,因为它将在创建策略的下一个步骤中使用。
创建策略 create-policy
创建新策略需要您提供营销活动的URI ID,以及禁止该营销活动的使用标签表达式。
此表达式称为策略表达式,它是包含(A)标签或(B)运算符和操作数的对象,但不能同时包含两者。 反过来,每个操作数也是策略表达式对象。 例如,在以下情况下,可能会禁止将数据导出到第三方的政策 C1 OR (C3 AND C7)
存在标签。 此表达式将指定为:
"deny": {
"operator": "OR",
"operands": [
{
"label": "C1"
},
{
"operator": "AND",
"operands": [
{
"label": "C3"
},
{
"label": "C7"
}
]
}
]
}
POST配置策略表达式后,您可以通过向 /policies/custom
端点。
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,以便在下一个步骤中启用该策略。
启用策略
默认情况下,策略具有以下属性: status
属性设置为 DRAFT
不参与评估。 您可以向以下网站发出PATCH请求,以启用策略进行评估: /policies/custom/
端点并在请求路径末尾提供策略的唯一标识符。
API格式
PATCH /policies/custom/{POLICY_ID}
{POLICY_ID}
id
要启用的策略的值。请求
以下请求对执行PATCH操作 status
策略的属性,更改其值 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
path
value
path
. 此请求设置策略的 status
属性更改为“ENABLED”。响应
成功的响应返回HTTP状态200 (正常)和已更新策略的详细信息,以及其 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 用户界面,请参见 策略用户指南.