Habilitar un conjunto de datos para actualizaciones de perfil mediante API

Este tutorial cubre el proceso de activación de un conjunto de datos con funciones de "actualización" para realizar actualizaciones de los datos del perfil del cliente en tiempo real. Esto incluye pasos para crear un nuevo conjunto de datos y configurar uno existente.

Introducción

Este tutorial requiere una comprensión práctica de varios servicios de Adobe Experience Platform implicados en la administración de conjuntos de datos con perfil habilitado. Antes de comenzar este tutorial, revise la documentación de estos temas relacionados Platform servicios:

Las secciones siguientes proporcionan información adicional que deberá conocer para realizar llamadas correctamente a las API de Platform.

Lectura de llamadas de API de muestra

Este tutorial proporciona llamadas de API de ejemplo para demostrar cómo dar formato a las solicitudes. Estas incluyen rutas, encabezados obligatorios y cargas de solicitud con el formato correcto. También se proporciona el JSON de muestra devuelto en las respuestas de la API. Para obtener información sobre las convenciones utilizadas en la documentación de las llamadas de API de ejemplo, consulte la sección sobre cómo leer llamadas de API de ejemplo en el Experience Platform guía de solución de problemas.

Recopilación de valores para los encabezados obligatorios

Para realizar llamadas a Platform API, primero debe completar el tutorial de autenticación. Al completar el tutorial de autenticación, se proporcionan los valores para cada uno de los encabezados obligatorios en todas las llamadas de API de Experience Platform, como se muestra a continuación:

Todas las solicitudes que contienen una carga útil (POST, PUT, PATCH) requieren un Content-Type encabezado. El valor correcto de este encabezado se muestra en las solicitudes de ejemplo cuando es necesario.

Todos los recursos de Experience Platform están aisladas para zonas protegidas virtuales específicas. Todas las solicitudes a Platform Las API requieren un x-sandbox-name que especifica el nombre de la zona protegida en la que se realizará la operación. Para obtener más información sobre las zonas protegidas en Platform, consulte la documentación general de zona protegida.

Crear un conjunto de datos habilitado para actualizaciones de perfil

Al crear un nuevo conjunto de datos, puede habilitar ese conjunto de datos para Perfil y habilitar las funcionalidades de actualización en el momento de la creación.

Para crear un conjunto de datos habilitado para Perfil y actualizaciones, utilice una solicitud del POST a /dataSets punto final.

Formato de API

POST /dataSets

Solicitud

Al incluir tanto la variable unifiedIdentity y el unifiedProfile bajo tags en el cuerpo de la solicitud, el conjunto de datos estará habilitado para Profile tras la creación. Dentro de unifiedProfile matriz, agregar isUpsert:true agregará la capacidad del conjunto de datos para admitir actualizaciones.

curl -X POST \
  https://platform.adobe.io/data/foundation/catalog/dataSets \
  -H 'Content-Type: application/json' \
  -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}' \
  -d '{
        "name": "Sample dataset",
        "description: "A sample dataset with a sample description.",
        "schemaRef": {
            "id": "https://ns.adobe.com/{TENANT_ID}/schemas/31670881463308a46f7d2cb09762715",
            "contentType": "application/vnd.adobe.xed-full-notext+json; version=1"
        },
        "tags": {
            "unifiedIdentity": [
                "enabled: true"
            ],
            "unifiedProfile": [
                "enabled: true",
                "isUpsert: true"
            ]
        }
      }'

Respuesta

Una respuesta correcta muestra una matriz que contiene el ID del conjunto de datos recién creado en forma de "@/dataSets/{DATASET_ID}".

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Configurar un conjunto de datos existente configure-an-existing-dataset

Los siguientes pasos tratan sobre cómo configurar un conjunto de datos con perfil habilitado para la funcionalidad de actualización (actualización).

Compruebe si el conjunto de datos está habilitado para el perfil

Uso del Catalog API, puede inspeccionar un conjunto de datos existente para determinar si está habilitado para su uso en Real-Time Customer Profile. La siguiente llamada recupera los detalles de un conjunto de datos por ID.

Formato de API

GET /dataSets/{DATASET_ID}

Solicitud

curl -X GET 'https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e' \
  -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

{
    "5b020a27e7040801dedbf46e": {
        "name": "{DATASET_NAME}",
        "imsOrg": "{ORG_ID}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedIdentity": [
                "enabled:true"
            ],
            "unifiedProfile": [
                "enabled:true"
            ]
        },
        "version": "1.0.1",
        "created": 1536536917382,
        "updated": 1539793978215,
        "createdClient": "{CLIENT_CREATED}",
        "createdUser": "{CREATED_BY}",
        "updatedUser": "{CREATED_BY}",
        "viewId": "{VIEW_ID}",
        "files": "@/dataSetFiles?dataSetId=5b020a27e7040801dedbf46e",
        "schema": "{SCHEMA}",
        "schemaRef": {
            "id": "https://ns.adobe.com/xdm/context/experienceevent",
            "contentType": "application/vnd.adobe.xed+json"
        }
    }
}

En el tags propiedad, puede ver que unifiedProfile está presente con el valor enabled:true. Por lo tanto, Real-Time Customer Profile está habilitado para este conjunto de datos.

Deshabilitar el conjunto de datos para el perfil

Para configurar un conjunto de datos con perfil habilitado para las actualizaciones, primero debe deshabilitar la variable unifiedProfile y unifiedIdentity y, a continuación, vuelva a activarlas junto con el isUpsert etiqueta. Esto se realiza mediante dos solicitudes de PATCH, una para deshabilitar y otra para volver a habilitar.

Formato de API

PATCH /dataSets/{DATASET_ID}

Solicitud

El primer cuerpo de solicitud de PATCH incluye un path hasta unifiedProfile y una path hasta unifiedIdentity, configurando la variable value hasta enabled:false para ambas rutas con el fin de deshabilitar las etiquetas.

curl -X PATCH https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e \
  -H 'Content-Type:application/json-patch+json' \
  -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}' \
  -d '[
        {
            "op": "replace",
            "path": "/tags/unifiedProfile",
            "value": ["enabled:false"]
        },
        {
            "op": "replace",
            "path": "/tags/unifiedIdentity",
            "value": ["enabled:false"]
        }
      ]'

Respuesta

Una solicitud correcta del PATCH devuelve el estado HTTP 200 (OK) y una matriz que contiene el ID del conjunto de datos actualizado. Este ID debe coincidir con el enviado en la solicitud del PATCH. El unifiedProfile y unifiedIdentity Las etiquetas de se han desactivado.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Habilitar el conjunto de datos para perfiles y actualizaciones enable-the-dataset

Se puede habilitar un conjunto de datos existente para las actualizaciones de perfiles y atributos mediante una sola solicitud de PATCH.

Formato de API

PATCH /dataSets/{DATASET_ID}

Solicitud

El cuerpo de la solicitud incluye un path hasta unifiedProfile configuración del value para incluir el enabled y isUpsert etiquetas, ambas configuradas como true, y a path hasta unifiedIdentity configuración del value para incluir el enabled etiqueta establecida en true.

curl -X PATCH https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e \
  -H 'Content-Type:application/json-patch+json' \
  -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}' \
  -d '[
        {
            "op": "add",
            "path": "/tags/unifiedProfile",
            "value": [
                "enabled:true",
                "isUpsert:true"
            ]
        },
        {
            "op": "add",
            "path": "/tags/unifiedIdentity",
            "value": [
                "enabled:true"
            ]
        }
      ]'

Respuesta

Una solicitud correcta del PATCH devuelve el estado HTTP 200 (OK) y una matriz que contiene el ID del conjunto de datos actualizado. Este ID debe coincidir con el enviado en la solicitud del PATCH. El unifiedProfile etiqueta y unifiedIdentity ahora se han habilitado y configurado las etiquetas para las actualizaciones de atributos.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Pasos siguientes

Los flujos de trabajo de ingesta por lotes ahora pueden utilizar el perfil y el conjunto de datos habilitado para actualizar los datos del perfil. Para obtener más información sobre la ingesta de datos en Adobe Experience Platform, comience por leer el información general sobre ingesta de datos.