Extremo de trabajos de segmento
Un trabajo de segmentación es un proceso asincrónico que crea un segmento de audiencia bajo demanda. Hace referencia a una definición de segmento, así como a cualquier política de combinación que controla cómo Real-Time Customer Profile combina atributos superpuestos en los fragmentos de perfil. Cuando un trabajo de segmentación se completa correctamente, puede recopilar información diversa acerca del segmento, como los errores que se hayan podido producir durante el procesamiento y el tamaño final de la audiencia.
Esta guía proporciona información para ayudarle a comprender mejor los trabajos de los segmentos e incluye llamadas de API de muestra para realizar acciones básicas mediante la API.
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.
Recuperación de una lista de trabajos de segmentos retrieve-list
Puede recuperar una lista de todos los trabajos de segmentos de su organización realizando una petición GET al extremo /segment/jobs
.
Formato de API
El extremo /segment/jobs
admite varios parámetros de consulta para filtrar los resultados. Aunque estos parámetros son opcionales, se recomienda encarecidamente su uso para ayudar a reducir los costes generales. Si realiza una llamada a este extremo sin parámetros, se recuperarán todos los trabajos de exportación disponibles para su organización. Se pueden incluir varios parámetros, separados por el símbolo et (&
).
GET /segment/jobs
GET /segment/jobs?{QUERY_PARAMETERS}
Parámetros de consulta
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 | ||
---|---|---|
Parámetro | Descripción | Ejemplo |
start |
Especifica el desplazamiento inicial para los trabajos de segmento devueltos. | start=1 |
limit |
Especifica el número de trabajos de segmento devueltos por página. | limit=20 |
status |
Filtra los resultados según el estado. Los valores admitidos son NEW, QUEUED, PROCESSING, SUCCEEDED, FAILED, CANCELING, CANCELED | status=NEW |
sort |
Ordena los trabajos de segmento devueltos. Está escrito en el formato `[attributeName]:[desc | asc]`. |
property |
Filtra los trabajos de segmento y obtiene coincidencias exactas para el filtro dado. Se puede escribir en cualquiera de los siguientes formatos:
|
property=segments~segmentId==workInUS |
Solicitud
code language-shell |
---|
|
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con una lista de trabajos de segmento para la organización especificada como JSON. Se mostrará una lista completa de todas las definiciones de segmentos dentro del atributo children.segments
.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 | |
---|---|
Propiedad | Descripción |
id |
Identificador de solo lectura generado por el sistema para el trabajo de segmentación. |
status |
El estado actual del trabajo de segmentación. Los valores potenciales para el estado incluyen "NUEVO", "PROCESANDO", "CANCELANDO", "CANCELADO", "FALLIDO" y "CORRECTO". |
segments |
Un objeto que contiene información sobre las definiciones de segmento devueltas en el trabajo de segmentación. |
segments.segment.id |
El ID de la definición del segmento. |
segments.segment.expression |
Un objeto que contiene información sobre la expresión de la definición del segmento, escrita en PQL. |
metrics |
Un objeto que contiene información de diagnóstico sobre el trabajo de segmentación. |
metrics.totalTime |
Un objeto que contiene información sobre las veces que se inició y finalizó el trabajo de segmentación, así como el tiempo total empleado. |
metrics.profileSegmentationTime |
Un objeto que contiene información sobre las veces que se inició y finalizó la evaluación de la segmentación, así como el tiempo total empleado. |
metrics.segmentProfileCounter |
El número de perfiles cualificados por segmento. |
metrics.segmentedProfileByNamespaceCounter |
El número de perfiles cualificados para cada área de nombres de identidad por definición de segmento. |
metrics.segmentProfileByStatusCounter |
Recuento de perfiles para cada estado. Se admiten los tres estados siguientes:
|
metrics.totalProfilesByMergePolicy |
Número total de perfiles combinados por política de combinación. |
Creación de un nuevo trabajo de segmentación create
Puede crear un nuevo trabajo de segmento realizando una petición POST al extremo /segment/jobs
e incluyendo los ID de la definición del segmento en el cuerpo de la solicitud.
Formato de API
POST /segment/jobs
Solicitud
code language-shell |
---|
|
table 0-row-2 1-row-2 | |
---|---|
Propiedad | Descripción |
segmentId |
El ID de la definición del segmento que desea evaluar. Estas definiciones de segmentos pueden pertenecer a distintas políticas de combinación. Encontrará más información sobre las definiciones de segmentos en la guía de extremo de definición de segmento. |
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con información sobre el trabajo de segmento recién creado.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
---|---|
Propiedad | Descripción |
id |
Un identificador de solo lectura generado por el sistema para el trabajo de segmentación recién creado. |
status |
El estado actual del trabajo de segmentación. Dado que el trabajo de segmentación es recién creado, el estado siempre será "NUEVO". |
segments |
Un objeto que contiene información sobre las definiciones de segmento para las que se ejecuta este trabajo de segmento. |
segments.segment.id |
El ID de la definición de segmento proporcionada. |
segments.segment.expression |
Un objeto que contiene información sobre la expresión de la definición del segmento, escrita en PQL. |
Recuperar un trabajo de segmento específico get
Puede recuperar información detallada sobre un trabajo de segmento específico realizando una petición GET al extremo /segment/jobs
y proporcionando el ID del trabajo de segmento que desea recuperar en la ruta de solicitud.
Formato de API
GET /segment/jobs/{SEGMENT_JOB_ID}
{SEGMENT_JOB_ID}
id
del trabajo de segmentación que desea recuperar.Solicitud
code language-shell |
---|
|
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con información detallada sobre el trabajo de segmento especificado. Se mostrará una lista completa de todas las definiciones de segmentos dentro del atributo children.segments
.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 | |
---|---|
Propiedad | Descripción |
id |
Identificador de solo lectura generado por el sistema para el trabajo de segmentación. |
status |
El estado actual del trabajo de segmentación. Los valores potenciales para el estado incluyen "NUEVO", "PROCESANDO", "CANCELANDO", "CANCELADO", "FALLIDO" y "CORRECTO". |
segments |
Un objeto que contiene información sobre las definiciones de segmento devueltas en el trabajo de segmentación. |
segments.segment.id |
El ID de la definición del segmento. |
segments.segment.expression |
Un objeto que contiene información sobre la expresión de la definición del segmento, escrita en PQL. |
metrics |
Un objeto que contiene información de diagnóstico sobre el trabajo de segmentación. |
[!ENDTABS]
Recuperar trabajos de segmentos por lotes bulk-get
Puede recuperar información detallada sobre varios trabajos de segmento realizando una petición POST al extremo /segment/jobs/bulk-get
y proporcionando los valores id
de los trabajos de segmento en el cuerpo de la solicitud.
Formato de API
POST /segment/jobs/bulk-get
Solicitud
code language-shell |
---|
|
Respuesta
Una respuesta correcta devuelve el estado HTTP 207 con los trabajos de segmento solicitados.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
---|---|
Propiedad | Descripción |
id |
Identificador de solo lectura generado por el sistema para el trabajo de segmentación. |
status |
El estado actual del trabajo de segmentación. Los valores potenciales para el estado incluyen "NUEVO", "PROCESANDO", "CANCELANDO", "CANCELADO", "FALLIDO" y "CORRECTO". |
segments |
Un objeto que contiene información sobre las definiciones de segmento devueltas en el trabajo de segmentación. |
segments.segment.id |
El ID de la definición del segmento. |
segments.segment.expression |
Un objeto que contiene información sobre la expresión de la definición del segmento, escrita en PQL. |
Cancelar o eliminar un trabajo de segmento específico delete
Puede eliminar un trabajo de segmento específico realizando una petición DELETE al extremo /segment/jobs
y proporcionando el ID del trabajo de segmento que desea eliminar en la ruta de solicitud.
Formato de API
DELETE /segment/jobs/{SEGMENT_JOB_ID}
{SEGMENT_JOB_ID}
id
del trabajo de segmentación que desea eliminar.Solicitud
code language-shell |
---|
|
Respuesta
Una respuesta correcta devuelve el estado HTTP 204 con un cuerpo de respuesta vacío.
Pasos siguientes
Después de leer esta guía, ahora tiene una mejor comprensión de cómo funcionan los trabajos de segmentos.