Evaluar eventos en tiempo casi real con segmentación de streaming

Segmentación de streaming en Adobe Experience Platform permite a los clientes realizar la segmentación en tiempo casi real al tiempo que se centran en la riqueza de datos. Con la segmentación por streaming, la calificación de segmentos ahora se produce cuando los datos de streaming llegan a Platform, aliviando la necesidad de programar y ejecutar trabajos de segmentación. Con esta capacidad, la mayoría de las reglas de segmentos ahora se pueden evaluar a medida que los datos se pasan a Platform, lo que significa que el abono a segmentos se mantendrá actualizado sin ejecutar trabajos de segmentación programados.

Introducción

Esta guía para desarrolladores requiere una comprensión práctica de los distintos Adobe Experience Platform servicios relacionados con la segmentación de streaming. Antes de comenzar este tutorial, revise la documentación de los siguientes servicios:

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

Lectura de llamadas de API de muestra

Esta guía para desarrolladores proporciona ejemplos de llamadas a la API 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:

Todos los recursos de Experience Platform están aisladas para zonas protegidas virtuales específicas. Todas las solicitudes a Platform Las API requieren un encabezado que especifique el nombre de la zona protegida en la que se realizará la operación:

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

Es posible que se requieran encabezados adicionales para completar solicitudes específicas. Los encabezados correctos se muestran en cada uno de los ejemplos de este documento. Preste especial atención a las solicitudes de ejemplo para asegurarse de que se incluyen todos los encabezados obligatorios.

Tipos de consulta habilitados para segmentación de streaming query-types

Para que una definición de segmento se evalúe mediante la segmentación de flujo continuo, la consulta debe cumplir las siguientes directrices.

Una definición de segmento no habilitarse para la segmentación de flujo continuo en los siguientes casos:

Tenga en cuenta las siguientes directrices a la hora de realizar la segmentación por streaming:

Si se modifica una definición de segmento para que ya no cumpla los criterios de segmentación de flujo continuo, la definición de segmento cambiará automáticamente de "Flujo" a "Lote".

Además, la descalificación de segmentos, de manera similar a la calificación de segmentos, se produce en tiempo real. Como resultado, si un perfil ya no cumple los requisitos para una definición de segmento, se descalifica inmediatamente. Por ejemplo, si la definición del segmento solicita "Todos los usuarios que compraron zapatos rojos en las últimas tres horas", después de tres horas, todos los perfiles que inicialmente se calificaron para la definición del segmento serán no calificados.

Recupere todas las definiciones de segmentos habilitadas para la segmentación de streaming

Puede recuperar una lista de todas las definiciones de segmentos habilitadas para la segmentación de streaming en su organización realizando una solicitud de GET a /segment/definitions punto final.

Formato de API

Para recuperar definiciones de segmentos habilitados para flujo continuo, debe incluir el parámetro de consulta evaluationInfo.continuous.enabled=true en la ruta de solicitud.

GET /segment/definitions?evaluationInfo.continuous.enabled=true

Solicitud

curl -X GET \
  'https://platform.adobe.io/data/core/ups/segment/definitions?evaluationInfo.continuous.enabled=true' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

Una respuesta correcta devuelve una matriz de definiciones de segmentos en su organización que están habilitadas para la segmentación de flujo continuo.

{
    "segments": [
        {
            "id": "15063cb-2da8-4851-a2e2-bf59ddd2f004",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "ttlInDays": 30,
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxId": "",
                "sandboxName": "",
                "type": "production",
                "default": true
            },
            "name": " People who are NOT on their homepage ",
            "expression": {
                "type": "PQL",
                "format": "pql/text",
                "value": "select var1 from xEvent where var1._experience.analytics.endUser.firstWeb.webPageDetails.isHomePage = false"
            },
            "evaluationInfo": {
                "batch": {
                    "enabled": false
                },
                "continuous": {
                    "enabled": true
                },
                "synchronous": {
                    "enabled": false
                }
            },
            "creationTime": 1572029711000,
            "updateEpoch": 1572029712000,
            "updateTime": 1572029712000
        },
        {
            "id": "f15063cb-2da8-4851-a2e2-bf59ddd2f004",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "ttlInDays": 30,
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxId": "",
                "sandboxName": "",
                "type": "production",
                "default": true
            },
            "name": "Homepage_continuous",
            "description": "People who are on their homepage - continuous",
            "expression": {
                "type": "PQL",
                "format": "pql/text",
                "value": "select var1 from xEvent where var1._experience.analytics.endUser.firstWeb.webPageDetails.isHomePage = true"
            },
            "evaluationInfo": {
                "batch": {
                    "enabled": true
                },
                "continuous": {
                    "enabled": true
                },
                "synchronous": {
                    "enabled": false
                }
            },
            "creationTime": 1572021085000,
            "updateEpoch": 1572021086000,
            "updateTime": 1572021086000
        }
    ],
    "page": {
        "totalCount": 2,
        "totalPages": 1,
        "sortField": "creationTime",
        "sort": "desc",
        "pageSize": 2,
        "limit": 100
    },
    "link": {}
}

Creación de una definición de segmento habilitada para streaming

Una definición de segmento se habilitará automáticamente para flujo continuo si coincide con uno de los tipos de segmentación de streaming enumerados arriba.

Formato de API

POST /segment/definitions

Solicitud

curl -X POST \
  https://platform.adobe.io/data/core/ups/segment/definitions \
  -H 'Authorization: Bearer {ACCESS_TOKEN}'  \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "schema": {
        "name": "_xdm.context.profile"
    },
    "ttlInDays": 30,
    "name": "Homepage_continuous",
    "description": "People who are on their homepage - continuous",
    "expression": {
        "type": "PQL",
        "format": "pql/text",
        "value": "select var1 from xEvent where var1._experience.analytics.endUser.firstWeb.webPageDetails.isHomePage = true"
    },
    "evaluationInfo": {
        "batch": {
            "enabled": false
        },
        "continuous": {
            "enabled": true
        },
        "synchronous": {
            "enabled": false
        }
    }
}'

Respuesta

Una respuesta correcta devuelve los detalles de la definición del segmento habilitado para flujo continuo recién creada.

{
    "id": "f15063cb-2da8-4851-a2e2-bf59ddd2f004",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "ttlInDays": 30,
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "{SANDBOX_ID}",
        "sandboxName": "{SANDBOX_NAME}",
        "type": "production",
        "default": true
    },
    "name": "Homepage_continuous",
    "description": "People who are on their homepage - continuous",
    "expression": {
        "type": "PQL",
        "format": "pql/text",
        "value": "select var1 from xEvent where var1._experience.analytics.endUser.firstWeb.webPageDetails.isHomePage = true"
    },
    "evaluationInfo": {
        "batch": {
            "enabled": false
        },
        "continuous": {
            "enabled": true,
                   },
        "synchronous": {
            "enabled": false
        }
    },
    "creationTime": 1572021085000,
    "updateEpoch": 1572021086000,
    "updateTime": 1572021086000
}

Habilitar evaluación programada enable-scheduled-segmentation

Una vez habilitada la evaluación de la transmisión, se debe crear una línea de base (después de la cual la definición del segmento siempre estará actualizada). La evaluación programada (también conocida como segmentación programada) debe habilitarse primero para que el sistema realice la línea de base automáticamente. Con la segmentación programada, su organización puede adherirse a una programación recurrente para ejecutar automáticamente los trabajos de exportación y evaluar las definiciones de segmentos.

Creación de una programación

Realizando una solicitud de POST a /config/schedules punto final, puede crear una programación e incluir la hora específica en la que se debe activar.

Formato de API

POST /config/schedules

Solicitud

La siguiente solicitud crea un nuevo programa basado en las especificaciones proporcionadas en la carga útil.

curl -X POST \
  https://platform.adobe.io/data/core/ups/config/schedules \
  -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": "{SCHEDULE_NAME}",
        "type": "batch_segmentation",
        "properties": {
            "segments": ["*"]
        },
        "schedule": "0 0 1 * * ?",
        "state": "inactive"
        }'

Respuesta

Una respuesta correcta devuelve los detalles de la programación recién creada.

{
    "id": "cd585edf-962d-420d-94ad-3be03e619ac2",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "e7e17720-c5bb-11e9-aafb-87c71c35cac8",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "name": "{SCHEDULE_NAME}",
    "state": "inactive",
    "type": "batch_segmentation",
    "schedule": "0 0 1 * * ?",
    "properties": {
        "segments": [
            "*"
        ]
    },
    "createEpoch": 1568267948,
    "updateEpoch": 1568267948
}

Habilitar una programación

De forma predeterminada, una programación está inactiva cuando se crea a menos que state La propiedad se establece en active en el cuerpo de la solicitud crear (POST). Puede activar una programación (establezca el state hasta active) realizando una solicitud de PATCH a /config/schedules e incluir el ID de la programación en la ruta.

Formato de API

POST /config/schedules/{SCHEDULE_ID}

Solicitud

La siguiente solicitud utiliza Formato de parche de JSON para actualizar el state de la programación a active.

curl -X POST \
  https://platform.adobe.io/data/core/ups/config/schedules/cd585edf-962d-420d-94ad-3be03e619ac2 \
  -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 '[
        {
          "op": "add",
          "path": "/state",
          "value": "active"
        }
      ]'

Respuesta

Una actualización correcta devuelve un cuerpo de respuesta vacío y un estado HTTP 204 (sin contenido).

Se puede utilizar la misma operación para desactivar una programación sustituyendo el "valor" de la solicitud anterior por "inactivo".

Pasos siguientes

Ahora que ha habilitado definiciones de segmentos nuevas y existentes para la segmentación de flujo continuo, y ha habilitado la segmentación programada para desarrollar una línea de base y realizar evaluaciones recurrentes, puede empezar a crear definiciones de segmentos habilitadas para flujo continuo para su organización.

Para aprender a realizar acciones similares y trabajar con definiciones de segmentos mediante la interfaz de usuario de Adobe Experience Platform, visite Guía del usuario del Generador de segmentos.

Apéndice

En la siguiente sección se enumeran las preguntas más frecuentes sobre la segmentación de streaming:

¿La "descalificación" de la segmentación de streaming también se produce en tiempo real?

En la mayoría de los casos, la descalificación de la segmentación de streaming se produce en tiempo real. Sin embargo, las definiciones de segmentos de flujo continuo que utilizan segmentos de segmentos sí lo hacen no descalificar en tiempo real, en lugar de descalificar después de 24 horas.

¿En qué datos funciona la segmentación por streaming?

La segmentación por flujo funciona en todos los datos que se ingirieron con una fuente de flujo continuo. Los segmentos ingeridos mediante una fuente basada en lotes se evaluarán todas las noches, incluso si cumplen los requisitos para la segmentación por transmisión. Los eventos transmitidos al sistema con una marca de tiempo de más de 24 horas se procesarán en el trabajo por lotes siguiente.

¿Cómo se definen las definiciones de segmentos como segmentación por lotes o de flujo continuo?

Una definición de segmento se define como segmentación por lotes o de flujo continuo basada en una combinación de tipo de consulta y duración del historial de eventos. Puede encontrar una lista de las definiciones de segmentos que se evaluarán como segmento de flujo continuo en la sección tipos de consulta de segmentación de streaming.

Tenga en cuenta que si un segmento contiene ambos un inSegment y una cadena de evento único directa, no cumple los requisitos para la segmentación de flujo continuo. Si desea que esta definición de segmento cumpla los requisitos de la segmentación de flujo continuo, debe hacer de la cadena de evento único directo su propia definición de segmento.

¿Por qué sigue aumentando el número de definiciones de segmento "cualificadas totales" mientras que el número de "últimos X días" permanece en cero dentro de la sección de detalles de la definición del segmento?

El número total de definiciones de segmentos cualificados se obtiene del trabajo de segmentación diario, que incluye audiencias que cumplen los requisitos para las definiciones de segmentos por lotes y de flujo continuo. Este valor se muestra para las definiciones de segmentos por lotes y de flujo continuo.

El número bajo los "últimos X días" solamente incluye audiencias que cumplen los requisitos de la segmentación de streaming y solamente aumenta si ha transmitido datos al sistema y estos se contabilizan en esa definición de transmisión. Este valor es solamente Se muestra para definiciones de segmentos de streaming. Como resultado, este valor mayo mostrar como 0 para las definiciones de segmentos por lotes.

Como resultado, si ve que el número bajo "Últimos X días" es cero y el gráfico de líneas también informa de cero, tiene no transmite al sistema todos los perfiles que cumplen los requisitos para esa definición de segmento.

¿Cuánto tiempo tarda una definición de segmento en estar disponible?

Una definición de segmento tarda hasta una hora en estar disponible.

¿Existen limitaciones a los datos que se transmiten en?

Para que los datos transmitidos se utilicen en la segmentación de flujo continuo, hay debe espaciado entre los eventos transmitidos en. Si se transmiten demasiados eventos en el mismo segundo, Platform los tratará como datos generados por bots y se descartarán. Como práctica recomendada, debería haber al menos cinco segundos entre los datos de evento para garantizar que los datos se utilizan correctamente.