Crear una directiva de uso de datos en la API

La variable API del servicio de directivas le 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 el Policy Service API. Para obtener una guía más completa de las diferentes operaciones disponibles en la API, consulte la Guía para desarrolladores de Policy Service.

Primeros pasos

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

  • Administración de datos de Adobe Experience Platform: El marco por el cual Platform exige el cumplimiento de las normas de uso de datos.
    • Etiquetas de uso de datos: Las etiquetas de uso de datos se aplican a los campos de datos XDM, especificando restricciones para el acceso a esos datos.
  • Experience Data Model (XDM): El marco normalizado por el cual Platform organiza los datos de experiencia del cliente.
  • Sandboxes: Experience Platform proporciona entornos limitados virtuales que dividen un solo Platform en entornos virtuales independientes para ayudar a desarrollar y desarrollar aplicaciones de experiencia digital.

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

Definir una acción de marketing

En el marco de control de datos, una acción de marketing es una acción que Experience Platform toma del consumidor de datos, para lo cual es necesario comprobar si hay 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 marketing evaluará la política. Esto se puede hacer con una de las siguientes opciones:

Buscar una acción de marketing existente

Puede consultar las acciones de marketing existentes que su directiva debe evaluar realizando una solicitud de GET a uno de los /marketingActions extremos.

Formato de API

Dependiendo de si está buscando una acción de marketing proporcionada por Experience Platform o una acción de marketing personalizada creada por su organización, use la variable marketingActions/core o marketingActions/custom endpoints, respectivamente.

GET /marketingActions/core
GET /marketingActions/custom

Solicitud

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

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 marketing encontradas (count) y enumera los detalles de las propias acciones de marketing dentro de la variable 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 dentro de la variable children 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 al /marketingActions/custom/ y proporcionando 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 dar 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 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: {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 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 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 política.

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 política 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 política. Por ejemplo, podría prohibirse una política relativa a la exportación de datos a terceros si C1 OR (C3 AND C7) las etiquetas están 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 configurada la expresión de directiva, puede crear una nueva directiva realizando una solicitud de POST al /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 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 Una matriz que contiene la variable href valor de una acción de marketing, obtenido en la variable paso anterior. Aunque en el ejemplo anterior solo se muestra una acción de marketing, también se pueden proporcionar varias acciones.
deny El objeto de expresión de directiva. Define las etiquetas de uso y las condiciones 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": "{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 generado por el sistema de solo lectura que identifica de forma exclusiva la política.

Registre el ID de URI de la política 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 la directiva en DRAFT 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 hacer excepciones para directivas en DRAFT estado.

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

Formato de API

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

Solicitud

La siguiente solicitud realiza una operación de PATCH en la variable status propiedad de la directiva, cambiar 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 "replace".
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 el status en "ENABLED".

Respuesta

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

Al seguir este tutorial, ha creado correctamente una directiva de uso de datos para una acción de marketing. Ahora puede continuar con el tutorial en aplicación de políticas de uso de datos para obtener información sobre cómo comprobar infracciones de directivas y administrarlas 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 políticas para Real-time Customer Profile datos, consulte el tutorial en cumplimiento del uso de datos para segmentos de audiencia.

Para aprender a administrar las políticas de uso en la Experience Platform interfaz de usuario, consulte la guía del usuario de directivas.

En esta página