Crear una directiva de uso de datos en la API

La API de servicio de directivas permite crear y administrar políticas de uso de datos para determinar qué acciones de marketing se pueden realizar con datos que contienen ciertas etiquetas de uso de datos.

Este documento proporciona un tutorial paso a paso para crear una política mediante la Policy Service API. Para obtener una guía más completa de las distintas operaciones disponibles en la API, consulte la guía para desarrolladores dePolicy Service.

Primeros pasos

Este tutorial requiere una comprensión práctica de los siguientes conceptos clave relacionados con la creación y evaluación de políticas:

  • Administración de datos: Marco mediante el cual Platform se aplica el cumplimiento de la normativa de uso de datos.
  • Etiquetasde uso de datos: Las etiquetas de uso de datos se aplican a los campos de datos XDM, especificando restricciones para acceder a los datos.
  • Modelo de datos de experiencia(XDM): El marco normalizado por el cual Platform organiza los datos de experiencia del cliente.
  • Simuladores: Experience Platform proporciona entornos limitados virtuales que dividen una sola Platform instancia en entornos virtuales independientes para ayudar a desarrollar y desarrollar aplicaciones de experiencia digital.

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

Definir una acción de mercadotecnia

En el Data Governance marco, una acción de marketing es una acción que realiza un consumidor de Experience Platform datos, para la cual es necesario verificar las infracciones de 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 mercadotecnia evaluará la política. Esto se puede realizar con una de las siguientes opciones:

Buscar una acción de mercadotecnia existente

Puede buscar las acciones de marketing existentes que su política debe evaluar realizando una solicitud de GET en uno de los /marketingActions extremos.

Formato API

En función de si está buscando una acción de mercadotecnia proporcionada por Experience Platform o una acción de mercadotecnia personalizada creada por su organización, utilice los puntos marketingActions/core o marketingActions/custom finales, respectivamente.

GET /marketingActions/core
GET /marketingActions/custom

Solicitud

La siguiente solicitud utiliza el punto final, que obtiene una lista de todas las acciones de marketing definidas por la organización de IMS. 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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

Una respuesta correcta devuelve el número total de acciones de mercadotecnia encontradas (count) y lista los detalles de las propias acciones de mercadotecnia 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": "{IMS_ORG}",
            "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": "{IMS_ORG}",
            "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 de la children matriz contiene un identificador URI para la acción de marketing de la lista.

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 la creación de una directiva.

Create a new marketing action

Puede crear una nueva acción de mercadotecnia haciendo una solicitud de PUT al extremo y proporcionando un nombre para la acción de mercadotecnia al final de la ruta de solicitud. /marketingActions/custom/

Formato 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 el identificador principal de la acción de marketing y, por lo tanto, debe ser único. Lo mejor es dar a la acción de mercadotecnia un nombre descriptivo pero conciso.

Solicitud

La siguiente solicitud crea una nueva acción de marketing personalizada denominada "exportToThirdParty". Observe que name en la carga útil de la solicitud es el mismo nombre que el proporcionado en la ruta de la 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: {IMS_ORG}' \
  -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 la solicitud o se producirá un error 400 (Solicitud incorrecta).
description Descripción legible por el usuario 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": "{IMS_ORG}",
    "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 ID de URI de la acción de marketing.

Registre el identificador URI de la acción de marketing recién creada, tal como se utilizará en el próximo paso de crear una política.

Crear una directiva

La creación de una nueva directiva requiere que proporcione el identificador 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 es también un objeto de expresión de políticas. Por ejemplo, una política relativa a la exportación de datos a un tercero podría estar prohibida si están presentes C1 OR (C3 AND C7) etiquetas. 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 configurada la expresión de directiva, puede crear una nueva directiva haciendo una solicitud de POST al extremo del /policies/custom extremo.

Formato API

POST /policies/custom

Solicitud

La siguiente solicitud crea una directiva denominada "Exportar datos a terceros", que proporciona una acción de marketing y una expresión de política 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: {IMS_ORG}' \
  -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 el paso anterior. Aunque el ejemplo anterior lista una sola acción de marketing, también se pueden proporcionar varias acciones.
deny El objeto de expresión de directivas. Define las etiquetas y condiciones de uso que harían que la política 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": "{IMS_ORG}",
    "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 Valor de sólo lectura generado por el sistema que identifica de forma exclusiva la política.

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

Habilitar la directiva

Nota

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

De forma predeterminada, las directivas que tienen sus status propiedades establecidas para DRAFT no participan en la evaluación. Puede habilitar la directiva para la evaluación realizando una solicitud de PATCH al extremo y proporcionando el identificador único para la directiva al final de la ruta de la solicitud. /policies/custom/

Formato 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 la status propiedad de la política, cambiando su valor de DRAFT a 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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '[
    {
      "op": "replace",
      "path": "/status",
      "value": "ENABLED"
    }
  ]'
Propiedad Descripción
op Tipo de operación de PATCH que se va a realizar. Esta solicitud realiza una operación de "reemplazo".
path Ruta al campo que se va a actualizar. Al habilitar una directiva, el valor debe establecerse en "/status".
value El nuevo valor que se asignará a la propiedad especificada en path. Esta solicitud establece la propiedad de la política en status "HABILITADO".

Respuesta

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

Pasos siguientes

Siguiendo este tutorial, ha creado correctamente una directiva de uso de datos para una acción de marketing. Ahora puede continuar con el tutorial sobre la aplicación de políticas de uso de datos para aprender a comprobar las infracciones de políticas y a gestionarlas en la aplicación de experiencia.

Para obtener más información sobre las distintas operaciones disponibles en la Policy Service API, consulte la guía para desarrolladores dePolicy Service. Para obtener información sobre cómo aplicar directivas para Real-time Customer Profile datos, consulte el tutorial sobre la aplicación de la conformidad de uso de datos para segmentosde audiencia.

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

En esta página