Creación de un segmento mediante la API del servicio de segmentación

Este documento proporciona un tutorial para desarrollar, probar, previsualizar y guardar una definición de segmento utilizando Adobe Experience Platform Segmentation Service API.

Para obtener información sobre cómo crear segmentos mediante la interfaz de usuario, consulte la guía del Generador de segmentos.

Primeros pasos

Este tutorial requiere una comprensión práctica de los distintos servicios Adobe Experience Platform implicados en la creación de segmentos de audiencia. Antes de comenzar este tutorial, consulte la documentación de los siguientes servicios:

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

Leer llamadas de API de ejemplo

Este tutorial proporciona llamadas de API de ejemplo para demostrar cómo dar formato a las solicitudes. Estas incluyen rutas de acceso, encabezados necesarios y cargas de solicitud con el formato correcto. 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 para las llamadas de API de ejemplo, 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 las API 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 necesarios en todas las llamadas a la API Experience Platform, como se muestra a continuación:

  • Autorización: Portador {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Todos los recursos de Experience Platform están aislados en entornos limitados virtuales específicos. Todas las solicitudes a las API Platform requieren un encabezado que especifique el nombre del simulador para pruebas en el que se realizará la operación:

  • x-sandbox-name: {SANDBOX_NAME}
NOTA

Para obtener más información sobre los entornos limitados en Platform, consulte la documentación general del entorno limitado.

Todas las solicitudes que contienen una carga útil (POST, PUT, PATCH) requieren un encabezado adicional:

  • Content-Type: application/json

Desarrollo de una definición de segmento

El primer paso en la segmentación es definir un segmento, representado en una construcción denominada definición de segmento. Una definición de segmento es un objeto que encapsula una consulta escrita en Profile Query Language (PQL). Este objeto también se denomina predicado PQL. Los predicados PQL definen las reglas para el segmento en función de las condiciones relacionadas con cualquier registro o serie temporal que proporcione a Real-time Customer Profile. Consulte la Guía de PQL para obtener más información sobre cómo escribir consultas de PQL.

Puede crear una nueva definición de segmento realizando una solicitud de POST al extremo /segment/definitions en la API Segmentation. El siguiente ejemplo describe cómo dar formato a una solicitud de definición, incluida la información necesaria para que un segmento se defina correctamente.

Para obtener una explicación detallada sobre cómo definir un segmento, lea la guía para desarrolladores de definiciones de segmento.

Estimar y previsualizar una audiencia

A medida que desarrolle su definición de segmento, puede utilizar las herramientas de estimación y vista previa dentro de Real-time Customer Profile para ver la información de resumen y así asegurarse de que está aislando la audiencia esperada. Las estimaciones proporcionan información estadística sobre una definición de segmento, como el tamaño de audiencia y el intervalo de confianza previstos. Las vistas previas proporcionan listas paginadas de perfiles aptos para una definición de segmento, lo que le permite comparar los resultados con lo que espera.

Al estimar y previsualizar la audiencia, puede probar y optimizar sus predicados PQL hasta que produzcan un resultado deseado, donde luego se puedan utilizar en una definición de segmento actualizada.

Se requieren dos pasos para obtener una vista previa o una estimación del segmento:

  1. Crear un trabajo de vista previa
  2. Ver estimación o vista previa mediante el ID del trabajo de vista previa

Cómo se generan las estimaciones

Las muestras de datos se utilizan para evaluar segmentos y estimar el número de perfiles aptos. Los nuevos datos se cargan en la memoria cada mañana (entre las 12:00 y las 2:00 de la mañana, hora del Pacífico, que es entre las 7 y las 9:00 horas, hora universal) y todas las consultas de segmentación se calculan utilizando los datos de muestra de ese día. Por consiguiente, cualquier campo nuevo añadido o dato adicional recopilado se reflejará en las estimaciones al día siguiente.

El tamaño de la muestra depende del número total de entidades en el almacén de perfiles. Estos tamaños de muestra se representan en la siguiente tabla:

Entidades en el almacén de perfiles Tamaño de la muestra
Menos de 1 millón Conjunto de datos completo
de 1 a 20 millones 1 millón
Más de 20 millones 5 % del total

Las estimaciones suelen durar entre 10 y 15 segundos, empezando por una estimación aproximada y refinándose a medida que se leen más registros.

Crear un trabajo de vista previa

Puede crear un nuevo trabajo de vista previa realizando una solicitud de POST al extremo /preview .

Puede encontrar instrucciones detalladas sobre la creación de un trabajo de vista previa en la guía de vistas previas y estimaciones de puntos finales.

Ver una estimación o vista previa

Los procesos de estimación y vista previa se ejecutan asincrónicamente, ya que las distintas consultas pueden tardar distintos períodos en completarse. Una vez iniciada una consulta, puede utilizar las llamadas a la API para recuperar (GET) el estado actual de la estimación o vista previa a medida que avanza.

Con la API Segmentation Service, puede buscar el estado actual de un trabajo de vista previa por su ID. Si el estado es "RESULT_READY", puede ver los resultados. Para buscar el estado actual de un trabajo de vista previa, lea la sección sobre recuperación de una sección de trabajo de vista previa en la guía de vistas previas y estimaciones de puntos finales. Para consultar el estado actual de un trabajo de estimación, lea la sección sobre recuperación de un trabajo de estimación en la guía de vistas previas y estimaciones de extremos.

Pasos siguientes

Una vez que haya desarrollado, probado y guardado su definición de segmento, puede crear un trabajo de segmento para crear una audiencia mediante la API Segmentation Service . Consulte el tutorial sobre evaluación y acceso a los resultados del segmento para ver los pasos detallados sobre cómo hacerlo.

En esta página