DocumentaciónExperience PlatformGuía del servicio de segmentación

Previsualizaciones y estimaciones de extremos

Last update: Fri Sep 06 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Temas:

Creado para:

  • Desarrollador

A medida que desarrolla una definición de segmento, puede utilizar las herramientas de estimación y previsualización de Adobe Experience Platform para ver información de resumen con el fin de asegurarse de aislar la audiencia que espera.

  • Vistas previas proporcionan listas paginadas de perfiles que cumplen los requisitos para una definición de segmento, lo que le permite comparar los resultados con lo que espera.

  • Estimaciones proporcionan información estadística sobre una definición de segmento, como el tamaño de audiencia proyectado, el intervalo de confianza y la desviación estándar de error.

NOTE
Para acceder a métricas similares relacionadas con los datos del perfil del cliente en tiempo real, como el número total de fragmentos de perfil y perfiles combinados en áreas de nombres específicas o el almacén de datos de perfil en su conjunto, consulte la guía de extremo de vista previa del perfil (estado de muestra de vista previa), que forma parte de la guía para desarrolladores de API de perfil.

Introducción

Los extremos utilizados en esta guía forman parte de la API Adobe Experience Platform Segmentation Service. Antes de continuar, revisa la guía de introducción para obtener información importante que necesitas conocer para poder realizar llamadas a la API correctamente, incluidos los encabezados requeridos y cómo leer llamadas de API de ejemplo.

Cómo se generan las estimaciones

Cuando la ingesta de registros en el almacén de perfiles aumenta o disminuye el recuento total de perfiles en más del 5 %, se activa un trabajo de muestreo para actualizar el recuento. La forma en que se activa el muestreo de datos depende del método de ingesta:

  • Ingesta por lotes: Para la ingesta por lotes, dentro de los 15 minutos siguientes a la ingesta correcta de un lote en el almacén de perfiles, si se alcanza el umbral de aumento o disminución del 5%, se ejecuta un trabajo para actualizar el recuento.
  • Ingesta de transmisión: Para los flujos de trabajo de transmisión de datos, se realiza una comprobación cada hora para determinar si se ha alcanzado el umbral de aumento o disminución del 5%. En caso afirmativo, se activa automáticamente un trabajo para actualizar el recuento.

El tamaño de la muestra de la exploración depende del número total de entidades del 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 muestra
Menos de 1 millón
Conjunto de datos completo
1 a 20 millones
1 millón
Más de 20 millones
5 % del total
NOTE
Las estimaciones generalmente tardan entre 10 y 15 segundos en ejecutarse, comenzando con una estimación aproximada y perfeccionando a medida que se leen más registros.

Crear una nueva vista previa create-preview

Puede crear una nueva vista previa realizando una solicitud de POST al extremo /preview.

NOTE
Se crea automáticamente un trabajo de estimación cuando se crea un trabajo de vista previa. Estos dos trabajos compartirán el mismo ID.

Formato de API

POST /preview

Solicitud

Una solicitud de ejemplo para crear una vista previa.
code language-shell 
curl -X POST https://platform.adobe.io/data/core/ups/preview \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '
    {
        "predicateExpression": "xEvent.metrics.commerce.abandons.value > 0",
        "predicateType": "pql/text",
        "predicateModel": "_xdm.context.profile",
        "graphType": "none"
    }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Propiedad Descripción
predicateExpression Expresión de PQL por la que se consultan los datos.
predicateType El tipo de predicado para la expresión de consulta en predicateExpression. Actualmente, el único valor aceptado para esta propiedad es pql/text.
predicateModel Nombre de la clase de esquema Experience Data Model (XDM) en la que se basan los datos de perfil.
graphType El tipo de gráfico del que desea obtener el clúster. Los valores admitidos son none (no realiza la vinculación de identidad) y pdg (realiza la vinculación de identidad en función de su gráfico de identidad privado).

Respuesta

Una respuesta correcta devuelve el estado HTTP 201 (Creado) con detalles de la previsualización recién creada.

Una respuesta de ejemplo al crear una vista previa.
code language-json 
{
    "state": "NEW",
    "previewQueryId": "e890068b-f5ca-4a8f-a6b5-af87ff0caac3",
    "previewQueryStatus": "NEW",
    "previewId": "MDphcHAtMzJiZTAzMjgtM2YzMS00YjY0LThkODQtYWNkMGM0ZmJkYWQzOmU4OTAwNjhiLWY1Y2EtNGE4Zi1hNmI1LWFmODdmZjBjYWFjMzow",
    "previewExecutionId": 0
}
table 0-row-2 1-row-2 2-row-2
Propiedad Descripción
state Estado actual del trabajo de vista previa. Cuando se cree inicialmente, estará en el estado "NUEVO". Posteriormente, estará en estado "EN EJECUCIÓN" hasta que se complete el procesamiento, momento en el que pasa a estar "RESULT_READY" o "FAILED".
previewId El ID del trabajo de vista previa, que se utilizará para fines de búsqueda al ver una estimación o vista previa, como se describe en la sección siguiente.

Recuperación de los resultados de una previsualización específica get-preview

Puede recuperar información detallada sobre una vista previa específica realizando una solicitud de GET al extremo /preview y proporcionando el ID de vista previa en la ruta de solicitud.

Formato de API

GET /preview/{PREVIEW_ID}
Parámetro
Descripción
{PREVIEW_ID}
El valor previewId de la vista previa que desea recuperar.

Solicitud

Una solicitud de ejemplo para recuperar una vista previa.
code language-shell 
curl -X GET https://platform.adobe.io/data/core/ups/preview/MDphcHAtMzJiZTAzMjgtM2YzMS00YjY0LThkODQtYWNkMGM0ZmJkYWQzOmU4OTAwNjhiLWY1Y2EtNGE4Zi1hNmI1LWFmODdmZjBjYWFjMzow \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

Una respuesta de ejemplo al recuperar una previsualización.

Una respuesta correcta devuelve el estado HTTP 200 con información detallada sobre la previsualización especificada.

code language-json 
{
   "results": [{
        "XID_ADOBE-MARKETING-CLOUD-ID-1": {
            "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_ADOBE-MARKETING-CLOUD-ID-1",
            "endCustomerIds": {
                "XID_COOKIE_ID_1": {
                    "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_COOKIE_ID_1"
                },
                "XID_PROFILE_ID_1": {
                    "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_PROFILE_ID_1"
                }
            }
        }
    },
    {
        "XID_COOKIE-ID-2": {
            "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_COOKIE-ID-2",
            "endCustomerIds": {
                "XID_COOKIE_ID_2-1": {
                    "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_COOKIE_ID_2-1"

                },
                "XID_PROFILE_ID_2": {
                    "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_PROFILE_ID_2"
                }
            }
        },
        "XID_ADOBE-MARKETING-CLOUD-ID-3": {
            "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_ADOBE-MARKETING-CLOUD-ID-1000"
        }
    }],
    "state": "RESULT_READY",
    "links": {
        "_self": "https://platform.adobe.io/data/core/ups/preview?expression=<expr-1>&limit=1000",
        "next": "",
        "prev": ""
    },
    "page": {
        "offset": 0,
        "size": 3
    }
}
table 0-row-2 1-row-2
Propiedad Descripción
results Una lista de ID de entidad, junto con sus identidades relacionadas. Los vínculos proporcionados se pueden usar para buscar las entidades especificadas mediante el extremo de API de acceso a perfiles.

Recuperar los resultados de un trabajo de estimación específico get-estimate

Una vez que haya creado un trabajo de vista previa, puede usar su previewId en la ruta de una solicitud de GET al extremo /estimate para ver información estadística sobre la definición del segmento, incluido el tamaño de audiencia proyectado, el intervalo de confianza y la desviación estándar de error.

Formato de API

GET /estimate/{PREVIEW_ID}
Parámetro
Descripción
{PREVIEW_ID}
Un trabajo de estimación solo se activa cuando se crea un trabajo de vista previa y los dos trabajos comparten el mismo valor de ID con fines de búsqueda. Específicamente, este es el valor previewId que se devolvió cuando se creó el trabajo de vista previa.

Solicitud

La siguiente solicitud recupera los resultados de un trabajo de estimación específico.

Una solicitud de muestra para recuperar un trabajo de estimación.
code language-shell 
curl -X GET https://platform.adobe.io/data/core/ups/estimate/MDoyOjRhNDVlODUzLWFjOTEtNGJiNy1hNDI2LTE1MDkzN2I2YWY1Yzo0Mg \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

Una respuesta correcta devuelve el estado HTTP 200 con detalles del trabajo de estimación.

Una respuesta de muestra al recuperar un trabajo de estimación.
code language-json 
{
    "estimatedSize": 4275,
    "numRowsToRead": 4275,
    "estimatedNamespaceDistribution": [
        {
            "namespaceId": "4",
            "profilesMatchedSoFar": 35
        },
        {
            "namespaceId": "6",
            "profilesMatchedSoFar": 4275
        }
    ],
    "state": "RESULT_READY",
    "profilesReadSoFar": 4275,
    "standardError": 0,
    "error": {
        "description": "",
        "traceback": ""
    },
    "profilesMatchedSoFar": 4275,
    "totalRows": 4275,
    "confidenceInterval": "95%",
    "_links": {
        "preview": "https://platform.adobe.io/data/core/ups/preview/app-32be0328-3f31-4b64-8d84-acd0c4fbdad3/execution/0?previewQueryId=e890068b-f5ca-4a8f-a6b5-af87ff0caac3"
    }
}
table 0-row-2 1-row-2 2-row-2 3-row-2
Propiedad Descripción
estimatedNamespaceDistribution Matriz de objetos que muestra el número de perfiles dentro de la definición del segmento desglosados por área de nombres de identidad. El número total de perfiles por área de nombres (sumando los valores mostrados para cada área de nombres) puede ser mayor que la métrica de recuento de perfiles, ya que un perfil se puede asociar con varias áreas de nombres. Por ejemplo, si un cliente interactúa con su marca en más de un canal, se asociarán varias áreas de nombres a ese cliente individual.
state Estado actual del trabajo de vista previa. El estado será "EN EJECUCIÓN" hasta que se complete el procesamiento, momento en el que pasará a ser "RESULT_READY" o "FAILED".
_links.preview Cuando state es "RESULT_READY", este campo proporciona una dirección URL para ver la estimación.

Pasos siguientes

Después de leer esta guía, debería tener una mejor comprensión de cómo trabajar con vistas previas y estimaciones mediante la API de segmentación. Para obtener información sobre cómo acceder a las métricas relacionadas con los datos del perfil del cliente en tiempo real, como el número total de fragmentos de perfil y perfiles combinados en áreas de nombres específicas o el almacén de datos de perfil en su conjunto, visite la guía de extremo de vista previa de perfil (/previewsamplestatus).

recommendation-more-help
770bc05d-534a-48a7-9f07-017ec1e14871