Adobe Experience Platform le permite crear segmentos que definen un grupo de atributos o comportamientos específicos a partir de un grupo de perfiles. 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 del segmento en función de las condiciones relacionadas con cualquier registro o datos de series temporales que proporcione a Real-Time Customer Profile. Consulte la Guía de PQL para obtener más información sobre cómo escribir consultas PQL.
Esta guía proporciona información para ayudarle a comprender mejor las definiciones de segmentos e incluye llamadas de API de ejemplo para realizar acciones básicas mediante la API.
Los extremos utilizados en esta guía forman parte del Adobe Experience Platform Segmentation Service API. Antes de continuar, consulte la guía de introducción para obtener información importante que necesita conocer para realizar llamadas correctamente a la API de, incluidos los encabezados obligatorios y cómo leer llamadas de API de ejemplo.
Puede recuperar una lista de todas las definiciones de segmentos para su organización realizando una solicitud de GET a /segment/definitions
punto final.
Formato de API
El /segment/definitions
el punto de conexión 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 punto final sin parámetros, recuperará todas las definiciones de segmentos disponibles para su organización. Se pueden incluir varios parámetros separados por el símbolo et (&
).
GET /segment/definitions
GET /segment/definitions?{QUERY_PARAMETERS}
Parámetros de consulta
Parámetro | Descripción | Ejemplo |
---|---|---|
start |
Especifica el desplazamiento inicial para las definiciones de segmento devueltas. | start=4 |
limit |
Especifica el número de definiciones de segmento devueltas por página. | limit=20 |
page |
Especifica la página desde la que se iniciarán los resultados de las definiciones de segmentos. | page=5 |
sort |
Especifica por qué campo ordenar los resultados. Está escrito en el siguiente formato: `[attributeName]:[desc | asc]`. |
evaluationInfo.continuous.enabled |
Especifica si la definición del segmento está habilitada para flujo continuo. | evaluationInfo.continuous.enabled=true |
Solicitud
La siguiente solicitud recuperará las dos últimas definiciones de segmento publicadas en su organización.
curl -X GET https://platform.adobe.io/data/core/ups/segment/definitions?limit=2 \
-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 una lista de definiciones de segmento para la organización especificada como JSON.
{
"segments": [
{
"id": "3da8bad9-29fb-40e0-b39e-f80322e964de",
"schema": {
"name": "_xdm.context.profile"
},
"ttlInDays": 30,
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"sandboxName": "prod",
"type": "production",
"default": true
},
"name": "segment",
"description": "",
"expression": {
"type": "PQL",
"format": "pql/json",
"value": "{PQL_EXPRESSION}"
},
"mergePolicyId": "b83185bb-0bc6-489c-9363-0075eb30b4c8",
"evaluationInfo": {
"batch": {
"enabled": true
},
"continuous": {
"enabled": false
},
"synchronous": {
"enabled": false
}
},
"dataGovernancePolicy": {
"excludeOptOut": true
},
"creationTime": 1573253640000,
"baselineTime": 1574327114,
"updateEpoch": 1575588309,
"updateTime": 1575588309000
},
{
"id": "ca763983-5572-4ea4-809c-b7dff7e0d79b",
"schema": {
"name": "_xdm.context.profile"
},
"ttlInDays": 30,
"imsOrgId": "{ORG_ID}",
"name": "test segment",
"description": "",
"expression": {
"type": "PQL",
"format": "pql/json",
"value": "{PQL_EXPRESSION}"
},
"mergePolicyId": "b83185bb-0bc6-489c-9363-0075eb30b4c8",
"evaluationInfo": {
"batch": {
"enabled": true
},
"continuous": {
"enabled": false
},
"synchronous": {
"enabled": false
}
},
"dataGovernancePolicy": {
"excludeOptOut": true
},
"creationTime": 1561073779000,
"baselineTime": 1574327114,
"updateEpoch": 1574327114,
"updateTime": 1574327114000
}
],
"page": {
"totalCount": 2,
"totalPages": 1,
"sortField": "creationTime",
"sort": "desc",
"pageSize": 2,
"limit": 100
},
"link": {}
}
Puede crear una nueva definición de segmento realizando una solicitud de POST a /segment/definitions
punto final.
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-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
-d '{
"name": "People who ordered in the last 30 days",
"profileInstanceId": "ups",
"description": "Last 30 days",
"expression": {
"type": "PQL",
"format": "pql/text",
"value": "workAddress.country = \"US\""
},
"evaluationInfo": {
"batch": {
"enabled": true
},
"continuous": {
"enabled": false
},
"synchronous": {
"enabled": false
}
},
"schema": {
"name": "_xdm.context.profile"
},
"payloadSchema": "string",
"ttlInDays": 60
}'
Propiedad | Descripción |
---|---|
name |
Requerido. Un nombre único por el que hacer referencia al segmento. |
description |
Una descripción de la definición del segmento que está creando. |
evaluationInfo |
El tipo de segmento que está creando. Si desea crear un segmento por lotes, defina evaluationInfo.batch.enabled para ser verdad. Si desea crear un segmento de flujo continuo, establezca evaluationInfo.continuous.enabled para ser verdad. Si desea crear un segmento de borde, defina evaluationInfo.synchronous.enabled para ser verdad. Si se deja vacío, el segmento se creará como lote segmento. |
schema |
Requerido. El esquema asociado a las entidades del segmento. Consta de un id o name field. |
expression |
Requerido. Una entidad que contiene campos e información sobre la definición del segmento. |
expression.type |
Especifica el tipo de expresión. Actualmente, solo se admite "PQL". |
expression.format |
Indica la estructura de la expresión en el valor. Actualmente, se admite el siguiente formato:
|
expression.value |
Una expresión que se ajuste al tipo indicado en expression.format . |
description |
Una descripción legible en lenguaje natural de la definición. |
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con detalles de la definición del segmento recién creada.
{
"id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
"schema": {
"name": "_xdm.context.profile"
},
"ttlInDays": 60,
"profileInstanceId": "ups",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"sandboxName": "prod",
"type": "production",
"default": true
},
"name": "People who ordered in the last 30 days",
"description": "Last 30 days",
"expression": {
"type": "PQL",
"format": "pql/text",
"value": "workAddress.country = \"US\""
},
"evaluationInfo": {
"batch": {
"enabled": true
},
"continuous": {
"enabled": false
},
"synchronous": {
"enabled": false
}
},
"dataGovernancePolicy": {
"excludeOptOut": true
},
"creationTime": 0,
"updateEpoch": 1579292094,
"updateTime": 1579292094000
}
Propiedad | Descripción |
---|---|
id |
Un ID generado por el sistema de la definición del segmento recién creada. |
evaluationInfo |
Un objeto que indica a qué tipo de evaluación se someterá la definición del segmento. Puede ser segmentación por lotes, por secuencias (también conocida como continua) o por perímetros (también conocida como sincrónica). |
Puede recuperar información detallada sobre una definición de segmento específica realizando una solicitud de GET al /segment/definitions
y proporciona el ID de la definición del segmento que desea recuperar en la ruta de solicitud.
Formato de API
GET /segment/definitions/{SEGMENT_ID}
Parámetro | Descripción |
---|---|
{SEGMENT_ID} |
El id valor de la definición del segmento que desea recuperar. |
Solicitud
curl -X GET https://platform.adobe.io/data/core/ups/segment/definitions/4afe34ae-8c98-4513-8a1d-67ccaa54bc05 \
-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 información detallada sobre la definición de segmento especificada.
{
"id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
"schema": {
"name": "_xdm.context.profile"
},
"ttlInDays": 60,
"profileInstanceId": "ups",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"sandboxName": "prod",
"type": "production",
"default": true
},
"name": "People who ordered in the last 30 days",
"description": "Last 30 days",
"expression": {
"type": "PQL",
"format": "pql/text",
"value": "workAddress.country = \"US\""
},
"evaluationInfo": {
"batch": {
"enabled": true
},
"continuous": {
"enabled": false
},
"synchronous": {
"enabled": false
}
},
"dataGovernancePolicy": {
"excludeOptOut": true
},
"creationTime": 0,
"updateEpoch": 1579292094,
"updateTime": 1579292094000
}
Propiedad | Descripción |
---|---|
id |
ID de solo lectura generado por el sistema para la definición del segmento. |
name |
Un nombre único por el que hacer referencia al segmento. |
schema |
El esquema asociado a las entidades del segmento. Consta de un id o name field. |
expression |
Una entidad que contiene campos e información sobre la definición del segmento. |
expression.type |
Especifica el tipo de expresión. Actualmente, solo se admite "PQL". |
expression.format |
Indica la estructura de la expresión en el valor. Actualmente, se admite el siguiente formato:
|
expression.value |
Una expresión que se ajuste al tipo indicado en expression.format . |
description |
Una descripción de la definición en lenguaje natural. |
evaluationInfo |
Objeto que indica a qué tipo de evaluación, lote, flujo (también conocido como continuo) o perímetro (también conocido como sincrónico) se someterá la definición del segmento. |
Puede recuperar información detallada sobre varias definiciones de segmentos especificadas realizando una solicitud de POST a /segment/definitions/bulk-get
y proporciona el id
valores de las definiciones de segmentos en el cuerpo de la solicitud.
Formato de API
POST /segment/definitions/bulk-get
Solicitud
curl -X POST https://platform.adobe.io/data/core/ups/segment/definitions/bulk-get \
-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 '{
"ids": [
{
"id": "54669488-03ab-4e0d-a694-37fe49e32be8"
},
{
"id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05"
}
]
}'
Respuesta
Una respuesta correcta devuelve el estado HTTP 207 con las definiciones de segmento solicitadas.
{
"results": {
"54669488-03ab-4e0d-a694-37fe49e32be8": {
"id": "54669488-03ab-4e0d-a694-37fe49e32be8",
"schema": {
"name": "_xdm.context.profile"
},
"ttlInDays": 60,
"profileInstanceId": "ups",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"sandboxName": "prod",
"type": "production",
"default": true
},
"name": "People who ordered in the last 30 days",
"description": "Last 30 days",
"expression": {
"type": "PQL",
"format": "pql/text",
"value": "workAddress.country = \"US\""
},
"evaluationInfo": {
"batch": {
"enabled": true
},
"continuous": {
"enabled": false
},
"synchronous": {
"enabled": false
}
},
"dataGovernancePolicy": {
"excludeOptOut": true
},
"creationTime": 0,
"updateEpoch": 1579292094,
"updateTime": 1579292094000
},
"4afe34ae-8c98-4513-8a1d-67ccaa54bc05": {
"id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
"schema": {
"name": "_xdm.context.profile"
},
"ttlInDays": 60,
"profileInstanceId": "ups",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"sandboxName": "prod",
"type": "production",
"default": true
},
"name": "People who ordered in the last 30 days",
"description": "Last 30 days",
"expression": {
"type": "PQL",
"format": "pql/text",
"value": "workAddress.country = \"US\""
},
"evaluationInfo": {
"batch": {
"enabled": true
},
"continuous": {
"enabled": false
},
"synchronous": {
"enabled": false
}
},
"dataGovernancePolicy": {
"excludeOptOut": true
},
"creationTime": 0,
"updateEpoch": 1579292094,
"updateTime": 1579292094000
}
}
}
Propiedad | Descripción |
---|---|
id |
ID de solo lectura generado por el sistema para la definición del segmento. |
name |
Un nombre único por el que hacer referencia al segmento. |
schema |
El esquema asociado a las entidades del segmento. Consta de un id o name field. |
expression |
Una entidad que contiene campos e información sobre la definición del segmento. |
expression.type |
Especifica el tipo de expresión. Actualmente, solo se admite "PQL". |
expression.format |
Indica la estructura de la expresión en el valor. Actualmente, se admite el siguiente formato:
|
expression.value |
Una expresión que se ajuste al tipo indicado en expression.format . |
description |
Una descripción de la definición en lenguaje natural. |
evaluationInfo |
Objeto que indica a qué tipo de evaluación, lote, flujo (también conocido como continuo) o perímetro (también conocido como sincrónico) se someterá la definición del segmento. |
Puede solicitar que se elimine una definición de segmento específica realizando una solicitud de DELETE a /segment/definitions
y proporciona el ID de la definición de segmento que desea eliminar en la ruta de solicitud.
Lo hará no poder eliminar un segmento que se utilice en una activación de destino.
Formato de API
DELETE /segment/definitions/{SEGMENT_ID}
Parámetro | Descripción |
---|---|
{SEGMENT_ID} |
El id valor de la definición de segmento que desea eliminar. |
Solicitud
curl -X DELETE https://platform.adobe.io/data/core/ups/segment/definitions/4afe34ae-8c98-4513-8a1d-67ccaa54bc05 \
-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 sin mensaje.
Puede actualizar una definición de segmento específica realizando una solicitud de PATCH a /segment/definitions
y proporciona el ID de la definición del segmento que desea actualizar en la ruta de solicitud.
Formato de API
PATCH /segment/definitions/{SEGMENT_ID}
Parámetro | Descripción |
---|---|
{SEGMENT_ID} |
El id valor de la definición del segmento que desea actualizar. |
Solicitud
La siguiente solicitud actualizará la dirección de trabajo del país de EE. UU. a Canadá.
curl -X PATCH https://platform.adobe.io/data/core/ups/segment/definitions/4afe34ae-8c98-4513-8a1d-67ccaa54bc05 \
-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 '
{
"id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
"name": "Updated people who ordered in the last 30 days",
"profileInstanceId": "ups",
"description": "Last 30 days",
"expression": {
"type": "PQL",
"format": "pql/text",
"value": "workAddress.country = \"CA\""
},
"schema": {
"name": "_xdm.context.profile"
},
"payloadSchema": "string",
"ttlInDays": 60,
"creationTime": 0,
"updateTime": 0,
"updateEpoch": 0
}'
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con detalles de la definición del segmento recién actualizada. Observe cómo se ha actualizado el país de la dirección de trabajo de EE. UU. (EE. UU.) a Canadá (CA).
{
"id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
"schema": {
"name": "_xdm.context.profile"
},
"ttlInDays": 60,
"profileInstanceId": "ups",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"sandboxName": "prod",
"type": "production",
"default": true
},
"name": "Updated people who ordered in the last 30 days",
"description": "Last 30 days",
"expression": {
"type": "PQL",
"format": "pql/text",
"value": "workAddress.country = \"CA\""
},
"evaluationInfo": {
"batch": {
"enabled": true
},
"continuous": {
"enabled": false
},
"synchronous": {
"enabled": false
}
},
"dataGovernancePolicy": {
"excludeOptOut": true
},
"creationTime": 0,
"updateEpoch": 1579295340,
"updateTime": 1579295340000
}
Puede convertir una definición de segmento entre pql/text
y pql/json
o pql/json
hasta pql/text
realizando una petición de POST a la /segment/conversion
punto final.
Formato de API
POST /segment/conversion
Solicitud
La siguiente solicitud cambiará el formato de la definición del segmento de pql/text
hasta pql/json
.
curl -X POST https://platform.adobe.io/data/core/ups/segment/conversion \
-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 '{
"name": "People who ordered in the last 30 days",
"profileInstanceId": "ups",
"description": "Last 30 days",
"expression": {
"type": "PQL",
"format": "pql/text",
"value": "workAddress.country = \"US\""
},
"schema": {
"name": "_xdm.context.profile"
},
"payloadSchema": "string",
"ttlInDays": 60
}'
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con detalles de la definición del segmento recién convertida.
{
"ttlInDays": 60,
"imsOrgId": "6A29340459CA8D350A49413A@AdobeOrg",
"sandbox": {
"sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
"sandboxName": "prod",
"type": "production",
"default": true
},
"description": "Last 30 days",
"expression": {
"type": "PQL",
"format": "pql/json",
"value": "{\"nodeType\":\"fnApply\",\"fnName\":\"=\",\"params\":[{\"nodeType\":\"fieldLookup\",\"fieldName\":\"country\",\"object\":{\"nodeType\":\"fieldLookup\",\"fieldName\":\"workAddress\",\"object\":{\"nodeType\":\"parameterReference\",\"position\":1}}},{\"nodeType\":\"literal\",\"literalType\":\"String\",\"value\":\"US\"}]}"
}
}
Después de leer esta guía, ahora tiene una mejor comprensión de cómo funcionan las definiciones de segmentos. Para obtener más información sobre la creación de segmentos, lea la creación de segmentos tutorial.