Habilitar un conjunto de datos para Profile y Identity Service mediante API

Este tutorial cubre el proceso de habilitar un conjunto de datos para utilizarlo en Real-Time Customer Profile y Identity Service, desglosado en los siguientes pasos:

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 servicios relacionados de Platform:

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 las llamadas de API de ejemplo en la guía de solución de problemas de Experience Platform.

Recopilación de valores para los encabezados obligatorios

Para poder realizar llamadas a las API de Platform, 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 encabezado Content-Type adicional. El valor correcto de este encabezado se muestra en las solicitudes de ejemplo cuando es necesario.

Todos los recursos de Experience Platform están aislados en zonas protegidas virtuales específicas. Todas las solicitudes a las API Platform requieren un encabezado 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 de información general sobre las zonas protegidas.

Crear un conjunto de datos habilitado para Perfil e identidad create-a-dataset-enabled-for-profile-and-identity

Puede habilitar un conjunto de datos para el perfil del cliente en tiempo real y el servicio de identidad inmediatamente después de la creación o en cualquier momento después de la creación del conjunto de datos. Si desea habilitar un conjunto de datos que ya se ha creado, siga los pasos para configurar un conjunto de datos existente que se encuentra más adelante en este documento.

Para crear un conjunto de datos habilitado para el perfil, puede usar una solicitud del POST al extremo /dataSets.

Formato de API

POST /dataSets

Solicitud

Al incluir unifiedProfile y unifiedIdentity en tags en el cuerpo de la solicitud, el conjunto de datos se habilitará inmediatamente para Profile y Identity Service, respectivamente. Los valores de estas etiquetas deben ser una matriz que contenga la cadena "enabled:true".

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 '{
    "schemaRef": {
        "id": "https://ns.adobe.com/{TENANT_ID}/schemas/31670881463308a46f7d2cb09762715",
        "contentType": "application/vnd.adobe.xed-full-notext+json; version=1"
    },
    "tags": {
       "unifiedProfile": ["enabled:true"],
       "unifiedIdentity": ["enabled: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}". Una vez que haya creado y habilitado correctamente un conjunto de datos, siga los pasos para cargar datos.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

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

Los siguientes pasos explican cómo habilitar un conjunto de datos creado anteriormente para Real-Time Customer Profile y Identity Service. Si ya ha creado un conjunto de datos con perfil habilitado, siga los pasos para introducir datos.

Compruebe si el conjunto de datos está habilitado check-if-the-dataset-is-enabled

Con la API Catalog, puede inspeccionar un conjunto de datos existente para determinar si está habilitado para usarse en Real-Time Customer Profile y Identity Service. 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": "Commission Program Events DataSet",
        "imsOrg": "{ORG_ID}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedProfile": [
                "enabled:true"
            ],
            "unifiedIdentity": [
                "enabled:true"
            ]
        },
        "version": "1.0.1",
        "created": 1536536917382,
        "updated": 1539793978215,
        "createdClient": "{CLIENT_CREATED}",
        "createdUser": "{CREATED_BY}",
        "updatedUser": "{CREATED_BY}",
        "viewId": "5b020a27e7040801dedbf46f",
        "files": "@/dataSetFiles?dataSetId=5b020a27e7040801dedbf46e",
        "schema": "@/xdms/context/experienceevent",
        "schemaRef": {
            "id": "https://ns.adobe.com/xdm/context/experienceevent",
            "contentType": "application/vnd.adobe.xed+json"
        }
    }
}

En la propiedad tags, puede ver que unifiedProfile y unifiedIdentity están presentes con el valor enabled:true. Por lo tanto, Real-Time Customer Profile y Identity Service están habilitados para este conjunto de datos, respectivamente.

Habilitar el conjunto de datos enable-the-dataset

Si el conjunto de datos existente no se ha habilitado para Profile o Identity Service, puede habilitarlo realizando una solicitud de PATCH con el ID del conjunto de datos.

Formato de API

PATCH /dataSets/{DATASET_ID}

Solicitud

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"] },
        { "op": "add", "path": "/tags/unifiedIdentity", "value": ["enabled:true"] }
      ]'

El cuerpo de la solicitud incluye path a dos tipos de etiquetas, unifiedProfile y unifiedIdentity. Los value de cada uno son matrices que contienen la cadena 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. Ahora se han agregado las etiquetas unifiedProfile y unifiedIdentity y los servicios de perfil e identidad han habilitado el uso del conjunto de datos.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Ingesta de datos en el conjunto de datos ingest-data-into-the-dataset

Tanto Real-Time Customer Profile como Identity Service consumen datos XDM a medida que se incorporan a un conjunto de datos. Para obtener instrucciones sobre cómo cargar datos en un conjunto de datos, consulte el tutorial sobre creación de un conjunto de datos mediante API. Cuando planee qué datos enviar a su conjunto de datos habilitado para Profile, tenga en cuenta las siguientes prácticas recomendadas:

Confirmar ingesta de datos por Real-Time Customer Profile confirm-data-ingest-by-real-time-customer-profile

Al cargar datos en un nuevo conjunto de datos por primera vez, o como parte de un proceso que implica un nuevo ETL o fuente de datos, se recomienda comprobar cuidadosamente los datos para asegurarse de que se han cargado según lo esperado. Con la API de acceso de Real-Time Customer Profile, puede recuperar los datos por lotes a medida que se cargan en un conjunto de datos. Si no puede recuperar ninguna de las entidades esperadas, es posible que el conjunto de datos no esté habilitado para Real-Time Customer Profile. Después de confirmar que el conjunto de datos se ha habilitado, asegúrese de que el formato de datos de origen y los identificadores cumplen con sus expectativas. Para obtener instrucciones detalladas sobre cómo usar la API Real-Time Customer Profile para obtener acceso a los datos de Profile, consulte la guía de extremo de entidades, también conocida como API Profile Access.

Confirmar ingesta de datos por servicio de identidad confirm-data-ingest-by-identity-service

Cada fragmento de datos introducido que contiene más de una identidad crea un vínculo en el gráfico de identidad privada. Para obtener más información sobre los gráficos de identidad y los datos de identidad de acceso, comience por leer la descripción general del servicio de identidad.