文件Experience Platform資料治理指南

使用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