Creación de una política de gobernanza de datos en la API

Última actualización: 2023-05-24
  • Creado para:
  • Developer
    User
    Admin
    Leader

El API del servicio de directivas le permite crear y administrar políticas de gobernanza de datos para determinar qué acciones de marketing se pueden realizar con datos que contengan determinadas etiquetas de uso de datos.

Este documento proporciona un tutorial paso a paso para crear una directiva de gobernanza utilizando Policy Service API.

NOTA

Para ver los pasos sobre cómo crear una directiva de control de acceso, consulte la /policies guía de extremo para API de control de acceso. Para obtener información sobre cómo crear una directiva de consentimiento, consulte la Guía de IU de directivas.

Primeros pasos

Este tutorial requiere una comprensión práctica de los siguientes conceptos clave implicados en la creación y evaluación de directivas:

  • Gobernanza de datos de Adobe Experience Platform: el marco mediante el cual Platform aplica el cumplimiento de uso de datos.
    • Etiquetas de uso de datos: las etiquetas de uso de datos se aplican a campos de datos XDM, especificando restricciones sobre cómo se puede acceder a esos datos.
  • Experience Data Model (XDM): El marco estandarizado mediante el cual Platform organiza los datos de experiencia del cliente.
  • Zonas protegidas: Experience Platform proporciona zonas protegidas virtuales que dividen una sola Platform en entornos virtuales independientes para ayudar a desarrollar y evolucionar aplicaciones de experiencia digital.

Antes de iniciar este tutorial, consulte la guía para desarrolladores para obtener información importante que necesita conocer para poder realizar llamadas correctamente a Policy Service API, incluidos los encabezados obligatorios y cómo leer las llamadas de API de ejemplo.

Definir una acción de marketing

En el marco de trabajo de control de datos, una acción de marketing es una acción que Experience Platform toma el consumidor de datos, para lo cual es necesario comprobar si se han infringido las políticas de uso de datos.

El primer paso para crear una política de uso de datos es determinar qué acción de marketing evaluará la política. Esto se puede hacer mediante una de las siguientes opciones:

Búsqueda de una acción de marketing existente

Puede buscar acciones de marketing existentes para que las evalúe la directiva realizando una solicitud de GET a uno de los /marketingActions puntos finales.

Formato de API

Dependiendo de si está buscando una acción de marketing proporcionada por Experience Platform Para una acción de marketing personalizada creada por su organización, utilice el marketingActions/core o marketingActions/custom puntos finales, respectivamente.

GET /marketingActions/core
GET /marketingActions/custom

Solicitud

La siguiente solicitud utiliza el marketingActions/custom extremo, que obtiene una lista de todas las acciones de marketing definidas por su organización.

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}'

Respuesta

Una respuesta correcta devuelve el número total de acciones de marketing encontradas (count) y enumera los detalles de las propias acciones de marketing dentro de la children matriz.

{
    "_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"
                }
            }
        }
    ]
}
Propiedad Descripción
_links.self.href Cada elemento dentro de children La matriz contiene un ID de URI para la acción de marketing enumerada.

Cuando encuentre la acción de marketing que desea utilizar, registre el valor de su href propiedad. Este valor se utiliza durante el siguiente paso de creación de una directiva.

Crear una nueva acción de marketing

Puede crear una nueva acción de marketing realizando una solicitud de PUT a /marketingActions/custom/ y proporciona un nombre para la acción de marketing al final de la ruta de solicitud.

Formato de API

PUT /marketingActions/custom/{MARKETING_ACTION_NAME}
Parámetro Descripción
{MARKETING_ACTION_NAME} Nombre de la nueva acción de marketing que desea crear. Este nombre actúa como identificador principal de la acción de marketing y, por lo tanto, debe ser único. Una práctica recomendada es asignar a la acción de marketing un nombre descriptivo pero conciso.

Solicitud

La siguiente solicitud crea una nueva acción de marketing personalizada llamada "exportToThirdParty". Observe que la variable name en la carga útil de la solicitud es el mismo que el nombre proporcionado en la ruta de solicitud.

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"
    }'
Propiedad Descripción
name Nombre de la acción de marketing que desea crear. Este nombre debe coincidir con el nombre proporcionado en la ruta de solicitud o se producirá un error 400 (Solicitud incorrecta).
description Una descripción legible en lenguaje natural de la acción de marketing.

Respuesta

Una respuesta correcta devuelve el estado HTTP 201 (Creado) y los detalles de la acción de marketing recién creada.

{
    "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"
        }
    }
}
Propiedad Descripción
_links.self.href El ID de URI de la acción de marketing.

Registre el ID de URI de la acción de marketing recién creada, tal como se utilizará en el siguiente paso de creación de una directiva.

Crear una directiva

La creación de una nueva directiva requiere que proporcione el ID de URI de una acción de marketing con una expresión de las etiquetas de uso que prohíben esa acción de marketing.

Esta expresión se denomina expresión de directiva y es un objeto que contiene (A) una etiqueta o (B) un operador y operandos, pero no ambos. A su vez, cada operando también es un objeto de expresión de directiva. Por ejemplo, una política relativa a la exportación de datos a un tercero podría estar prohibida si C1 OR (C3 AND C7) Hay etiquetas presentes. Esta expresión se especificaría como:

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

Solo se admiten los operadores OR y AND.

Una vez que haya configurado la expresión de directiva, puede crear una nueva directiva realizando una solicitud del POST a /policies/custom punto final.

Formato de API

POST /policies/custom

Solicitud

La siguiente solicitud crea una directiva denominada "Exportar datos a terceros" al proporcionar una acción de marketing y una expresión de directiva en la carga útil de la solicitud.

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"}
          ]
        }
      ]
    }
  }'
Propiedad Descripción
marketingActionRefs Matriz que contiene el href valor de una acción de marketing, obtenido en la variable paso anterior. Aunque el ejemplo anterior solo enumera una acción de marketing, también se pueden proporcionar varias acciones.
deny El objeto de expresión de directiva. Define las etiquetas y condiciones de uso que harían que la directiva rechazara la acción de marketing a la que se hace referencia en marketingActionRefs.

Respuesta

Una respuesta correcta devuelve el estado HTTP 201 (Creado) y los detalles de la directiva recién creada.

{
    "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"
}
Propiedad Descripción
id Un valor generado por el sistema de solo lectura que identifica de forma exclusiva la directiva.

Registre el ID de URI de la directiva recién creada, tal como se utiliza en el siguiente paso para habilitarla.

Habilitar la directiva

NOTA

Aunque este paso es opcional si desea dejar la directiva en DRAFT estado, tenga en cuenta que, de forma predeterminada, una directiva debe tener su estado establecido en ENABLED para participar en la evaluación. Consulte la guía de aplicación de políticas para obtener información sobre cómo establecer excepciones para directivas en DRAFT estado.

De forma predeterminada, las directivas que tienen su status propiedad establecida en DRAFT no participar en la evaluación. Puede habilitar la directiva para la evaluación realizando una solicitud de PATCH a /policies/custom/ y proporciona el identificador único de la política al final de la ruta de solicitud.

Formato de API

PATCH /policies/custom/{POLICY_ID}
Parámetro Descripción
{POLICY_ID} El id valor de la directiva que desea habilitar.

Solicitud

La siguiente solicitud realiza una operación de PATCH en status propiedad de la directiva, cambiando su valor de DRAFT hasta 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"
    }
  ]'
Propiedad Descripción
op Tipo de operación del PATCH que se va a realizar. Esta solicitud realiza una operación "replace".
path Ruta de acceso al campo que se va a actualizar. Al habilitar una directiva, el valor debe establecerse en "/status".
value El nuevo valor que se va a asignar a la propiedad especificada en path. Esta solicitud establece el status a "ENABLED".

Respuesta

Una respuesta correcta devuelve el estado HTTP 200 (OK) y los detalles de la directiva actualizada, con su status ahora se establece en 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"
}

Pasos siguientes

Al seguir este tutorial, ha creado correctamente una política de uso de datos para una acción de marketing. Ahora puede continuar con el tutorial sobre aplicación de políticas de uso de datos para obtener información sobre cómo comprobar violaciones de directivas y gestionarlas en la aplicación de experiencia.

Para obtener más información sobre las diferentes operaciones disponibles en la Policy Service API, consulte la Guía para desarrolladores de Policy Service. Para obtener información sobre cómo aplicar directivas para Real-Time Customer Profile para obtener más información, consulte el tutorial sobre aplicación del cumplimiento del uso de datos para segmentos de audiencia.

Para obtener información sobre cómo administrar las políticas de uso en Experience Platform interfaz de usuario, consulte la guía del usuario de directivas.

En esta página