Show Menu
TEMAS×

Configurar un conjunto de datos para Profile y Identity Service usar API

Este tutorial trata el proceso de habilitar un conjunto de datos para su uso en Real-time Customer Profile y Identity Service, desglosado en los siguientes pasos:
  1. Habilite un conjunto de datos para utilizarlo en Real-time Customer Profile, utilizando una de las dos opciones:

Primeros pasos

Este tutorial requiere un conocimiento práctico de los distintos servicios de Adobe Experience Platform que participan en la administración de conjuntos de datos Profilehabilitados. Antes de comenzar este tutorial, consulte la documentación de estos Platform servicios relacionados:
  • Perfil del cliente en tiempo real de : Proporciona un perfil de consumo unificado y en tiempo real basado en datos agregados de varias fuentes.
  • Identity Service : Permite Real-time Customer Profile el puente de identidades de orígenes de datos dispares que se están ingeriendo en Platform.
  • Servicio de catálogo : Una API RESTful que permite crear conjuntos de datos y configurarlos para Real-time Customer Profile y Identity Service.
  • Modelo de datos de experiencia(XDM) : El marco normalizado por el cual Platform organiza los datos de experiencia del cliente.
Las siguientes secciones proporcionan información adicional que deberá conocer para realizar llamadas exitosas a las API de plataforma.

Leer llamadas de API de muestra

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

Recopilar valores para encabezados necesarios

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 necesarios en todas las llamadas Experience Platform de API, como se muestra a continuación:
  • Autorización: Portador {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Todas las solicitudes que contienen una carga útil (POST, PUT, PATCH) requieren un encabezado adicional:
  • Content-Type: application/json
Todos los recursos de Experience Platform están aislados en entornos limitados virtuales específicos. Todas las solicitudes a Platform las API requieren un encabezado que especifique el nombre del simulador para pruebas en el que tendrá lugar la operación. Para obtener más información sobre los entornos limitados de Platform, consulte la documentación general del entorno limitado.
  • x-sandbox-name: {SANDBOX_NAME}

Crear un conjunto de datos habilitado para Profile y Identity

Puede habilitar un conjunto de datos para Real-time Customer Profile y Identity Service inmediatamente después de la creación o en cualquier punto después de que se haya creado el 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 nuevo conjunto de datos, debe conocer el ID de un esquema XDM existente que esté habilitado para el Perfil del cliente en tiempo real. Para obtener información sobre cómo buscar o crear un esquema con Perfil habilitado, consulte el tutorial sobre la creación de un esquema con la API del Registro de Esquema. La siguiente llamada a la Catalog API habilita un conjunto de datos para Profile y Identity Service.
Formato API
POST /dataSets

Solicitud
Al incluir unifiedProfile y unifiedIdentity en tags 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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "fileDescription" : {
    "persisted": true,
        "containerFormat": "parquet",
        "format": "parquet"
    },
    "fields":[],
    "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"]
    }
  }'

Propiedad
Descripción
schemaRef.id
ID del esquema Profilehabilitado en el que se basará el conjunto de datos.
{TENANT_ID}
La Área de nombres dentro de la Schema Registry cual contiene los recursos que pertenecen a su organización de IMS. Consulte la sección TENANT_ID de la guía para Schema Registry desarrolladores para obtener más información.
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, continúe con los pasos para cargar datos .
[
    "@/dataSets/5b020a27e7040801dedbf46e"
] 

Configurar un conjunto de datos existente

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 ingerir datos .

Compruebe si el conjunto de datos está habilitado

Mediante la Catalog API, puede inspeccionar un conjunto de datos existente para determinar si está habilitado para su uso en Real-time Customer Profile y Identity Service. La siguiente llamada recupera los detalles de un conjunto de datos por ID.
Formato API
GET /dataSets/{DATASET_ID}

Parámetro
Descripción
{DATASET_ID}
ID de un conjunto de datos que desea inspeccionar.
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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta
{
    "5b020a27e7040801dedbf46e": {
        "name": "Commission Program Events DataSet",
        "imsOrg": "{IMS_ORG}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedProfile": [
                "enabled:true"
            ],
            "unifiedIdentity": [
                "enabled:true"
            ]
        },
        "lastBatchId": "6dcd9128a1c84e6aa5177641165e18e4",
        "lastBatchStatus": "success",
        "dule": {},
        "statsCache": {
            "startDate": null,
            "endDate": null
        },
        "namespace": "ACP",
        "state": "DRAFT",
        "version": "1.0.1",
        "created": 1536536917382,
        "updated": 1539793978215,
        "createdClient": "{CLIENT_CREATED}",
        "createdUser": "{CREATED_BY}",
        "updatedUser": "{CREATED_BY}",
        "viewId": "5b020a27e7040801dedbf46f",
        "status": "enabled",
        "fileDescription": {
            "persisted": true,
            "containerFormat": "parquet",
            "format": "parquet"
        },
        "transforms": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/transforms",
        "files": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/files",
        "schema": "@/xdms/context/experienceevent",
        "schemaMetadata": {
            "primaryKey": [],
            "delta": [],
            "dule": [],
            "gdpr": []
        },
        "schemaRef": {
            "id": "https://ns.adobe.com/xdm/context/experienceevent",
            "contentType": "application/vnd.adobe.xed+json"
        }
    }
}

Bajo la tags propiedad, puede ver eso 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

Si el conjunto de datos existente no se ha habilitado para Profile o Identity Service, puede habilitarlo haciendo una solicitud de PATCH usando la ID del conjunto de datos.
Formato API
PATCH /dataSets/{DATASET_ID}

Parámetro
Descripción
{DATASET_ID}
ID de un conjunto de datos que desea actualizar.
Solicitud
curl -X PATCH \
  https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e \
  -H 'Content-Type: application/json' \
  -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}' \
  -d '{
    "tags" : {
        "unifiedProfile": ["enabled:true"],
        "unifiedIdentity": ["enabled:true"]
    }
  }'

El cuerpo de la solicitud incluye una tags propiedad que contiene dos subpropiedades: "unifiedProfile" y "unifiedIdentity" . Los valores de estas subpropiedades son matrices que contienen la cadena "enabled:true" .
Respuesta Una solicitud de PATCH correcta devuelve Estado HTTP 200 (Aceptar) y una matriz que contiene el ID del conjunto de datos actualizado. Este ID debe coincidir con el enviado en la solicitud de PATCH. Ahora se han agregado las etiquetas "unifiedProfile" y "unifiedIdentity" y el conjunto de datos está habilitado para su uso en Perfil e Identity Services.
[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Ingesta de datos en el conjunto de datos

Los datos XDM Real-time Customer Profile y Identity Service los consumen a medida que se van ingeriendo en un conjunto de datos. Para obtener instrucciones sobre cómo cargar datos en un conjunto de datos, consulte el tutorial sobre la creación de un conjunto de datos mediante API . Cuando planifique qué datos enviar al conjunto de datos Profilehabilitado, tenga en cuenta las siguientes optimizaciones:
  • Incluya los datos que desee utilizar como criterios de segmentos de audiencia.
  • Incluya tantos identificadores como pueda comprobar a partir de los datos de perfil para maximizar el gráfico de identidad. Esto permite Identity Service unir identidades entre conjuntos de datos de manera más eficaz.

Confirmar la ingesta de datos por Real-time Customer Profile

Al cargar datos en un nuevo conjunto de datos por primera vez, o como parte de un proceso que involucra una nueva ETL o fuente de datos, se recomienda comprobar cuidadosamente los datos para asegurarse de que se han cargado según lo esperado. Mediante la API de Real-time Customer Profile Access, puede recuperar datos por lotes a medida que se cargan en un conjunto de datos. Si no puede recuperar ninguna de las entidades que espera, 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 y los identificadores de los datos de origen admiten sus expectativas. Para obtener instrucciones detalladas sobre cómo utilizar la Real-time Customer Profile API para acceder a Profile los datos, siga la guía de extremo de entidades, también conocida como "Profile Access API".

Confirmar la ingesta de datos por servicio de identidad

Cada fragmento de datos ingerido 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, lea la información general del servicio de identidad.