Enviar ofertas utilizando la API Batch Decisioning deliver-offers-batch

La API Batch Decisioning permite a las organizaciones utilizar la funcionalidad de toma de decisiones para todos los perfiles de una audiencia determinada en una llamada. El contenido de la oferta para cada perfil de la audiencia se coloca en un conjunto de datos de Adobe Experience Platform, donde está disponible para flujos de trabajo por lotes personalizados.

Con la API Batch Decisioning, puede rellenar un conjunto de datos con las mejores ofertas para todos los perfiles de una audiencia de Adobe Experience Platform para los ámbitos de decisión. Por ejemplo, es posible que una organización desee ejecutar Batch Decisioning para que pueda enviar ofertas a un proveedor de entrega de mensajes. Estas ofertas se utilizan como contenido que se envía para la entrega de mensajes por lotes a la misma audiencia de usuarios.

Para ello, la organización debería:

  • Ejecute la API Batch Decisioning, que contiene dos solicitudes:

    1. Una solicitud de POST por lotes para iniciar una carga de trabajo para procesar por lotes las selecciones de ofertas.

    2. Una solicitud de GET por lotes para obtener el estado de carga de trabajo por lotes.

  • Exporte el conjunto de datos a la API del proveedor de entrega de mensajes.

NOTE
Las decisiones por lotes también se pueden realizar mediante la interfaz de Journey Optimizer. Para obtener más información, consulte esta sección, que proporciona información sobre los requisitos previos globales y las limitaciones que se deben tener en cuenta al utilizar la toma de decisiones por lotes.
  • Número de trabajos por lotes en ejecución por conjunto de datos: Se pueden ejecutar hasta cinco trabajos por lotes a la vez, por conjunto de datos. Cualquier otra solicitud por lotes con el mismo conjunto de datos de salida se agrega a la cola. Se selecciona un trabajo en cola para procesarlo una vez que el trabajo anterior ha terminado de ejecutarse.
  • Límite de frecuencia: Un lote se ejecuta fuera de la instantánea de perfil que se produce una vez al día. La API Batch Decisioning limita la frecuencia y siempre carga perfiles de la instantánea más reciente.

Introducción getting-started

Antes de utilizar esta API, asegúrese de completar los siguientes pasos previos.

Preparar la decisión prepare-decision

Para preparar una o más decisiones, asegúrese de haber creado un conjunto de datos, una audiencia y una decisión. Estos requisitos previos se detallan en esta sección.

Requisitos de API api-requirements

Todas las Batch Decisioning solicitudes requieren los siguientes encabezados además de los mencionados en la Guía para desarrolladores de API de administración de decisiones:

  • Content-Type: application/json
  • x-request-id: cadena única que identifica la solicitud.
  • x-sandbox-name: nombre de la zona protegida.

Iniciar un proceso por lotes start-a-batch-process

Para iniciar una carga de trabajo para procesar decisiones por lotes, realice una solicitud de POST al extremo /workloads/decisions.

NOTE
Encontrará información detallada sobre el tiempo de procesamiento de los trabajos por lotes en esta sección.

Formato de API

POST {ENDPOINT_PATH}/workloads/decisions
Parámetro
Descripción
Ejemplo
{ENDPOINT_PATH}
Ruta de extremo para las API del repositorio.
https://platform.adobe.io/data/core/dwm

Solicitud

curl -X POST 'https://platform.adobe.io/data/core/dwm/workloads/decisions' \
-H 'x-request-id: f671a589-eb7b-432f-b6b9-23d5b796b4dc' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'x-sandbox-id: {SANDBOX_ID}' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-d '{
  "xdm:segmentIds": [
    "609028e4-e66c-4776-b0d9-c782887e2273"
  ],
  "xdm:dataSetId": "6196b4a1a63bd118dafe093c",
  "xdm:propositionRequests": [
        {
            "xdm:activityId": "xcore:offer-activity:1410cdcda196707b",
            "xdm:placementId": "xcore:offer-placement:1410c4117306488a",
            "xdm:itemCount": 1
        }
  ],
  "xdm:includeContent": false
}'
Propiedad
Descripción
Ejemplo
xdm:segmentIds
El valor es una matriz que contiene el identificador único de la audiencia. Solo puede contener un valor.
609028e4-e66c-4776-b0d9-c782887e2273
xdm:dataSetId
Conjunto de datos de salida en el que se pueden escribir los eventos de decisión.
6196b4a1a63bd118dafe093c
xdm:propositionRequests
Un contenedor que contiene placementId y activityId
xdm:activityId
El identificador único de la decisión.
xcore:offer-activity:1410cdcda196707b
xdm:placementId
El identificador de ubicación único.
xcore:offer-placement:1410c4117306488a
xdm:itemCount
Es un campo opcional que muestra el número de elementos, como las opciones solicitadas para el ámbito de toma de decisiones. De forma predeterminada, la API devuelve una opción por ámbito, pero puede solicitar explícitamente más opciones especificando este campo. Se pueden solicitar un mínimo de 1 y un máximo de 30 opciones por ámbito.
1
xdm:includeContent
Este es un campo opcional y es false de manera predeterminada. Si true, el contenido de la oferta se incluye en los eventos de decisión del conjunto de datos.
false

Consulte la documentación de Administración de decisiones para obtener una descripción general de los conceptos y propiedades principales.

Respuesta

{
    "@id": "47efef25-4bcf-404f-96e2-67c4f784a1f5",
    "xdm:imsOrgId": "9GTO98D5F@AdobeOrg",
    "ode:createDate": 1648078924834,
    "ode:status": "QUEUED"
}
Propiedad
Descripción
Ejemplo
@id
El UUID generado por la administración de decisiones que identifica una sola carga de trabajo.
5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8
xdm:imsOrgId
El ID de la organización.
9GTO98D5F@AdobeOrg
ode:createDate
Hora a la que se creó la solicitud de carga de trabajo de decisión.
1648078924834
ode:status
El estado de la carga de trabajo.
ode:status: "QUEUED"

Recuperar información sobre una decisión por lotes retrieve-information-on-a-batch-decision

Para recuperar información sobre una decisión específica, realice una solicitud de GET al extremo /workloads/decisions y proporcione el valor de ID de carga de trabajo correspondiente para su decisión.

Formato de API

GET {ENDPOINT_PATH}/workloads/decisions/{WORKLOAD_ID}
Parámetro
Descripción
Ejemplo
{ENDPOINT_PATH}
Ruta de extremo para las API del repositorio.
https://platform.adobe.io/data/core/dwm
{WORKLOAD_ID}
El UUID generado por la administración de decisiones que identifica una sola carga de trabajo.
47efef25-4bcf-404f-96e2-67c4f784a1f5

Solicitud

curl -X GET 'https://platform.adobe.io/data/core/dwm/workloads/decisions/f395ab1f-dfaf-48d4-84c9-199ad6354591' \
-H 'x-request-id: 7832a42a-d4e5-413b-98e8-e49bef056436' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H'x-sandbox-id: {SANDBOX_ID}' \
-H 'Authorization: Bearer {ACCESS_TOKEN}'

Respuesta

{
   "@id": "f395ab1f-dfaf-48d4-84c9-199ad6354591",
    "xdm:imsOrgId": "{IMS_ORG}",
    "ode:createDate": 1648076994405,
    "ode:status": "COMPLETED"
}
Propiedad
Descripción
Ejemplo
@id
El UUID generado por la administración de decisiones que identifica una sola carga de trabajo.
5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8
xdm:imsOrgId
El ID de organización
9GTO98D5F@AdobeOrg
ode:createDate
Hora a la que se creó la solicitud de carga de trabajo de decisión.
1648076994405
ode:status
El estado de la carga de trabajo comienza con "EN COLA" y cambia a "PROCESANDO", "INGIRIENDO", "COMPLETADO" o "ERROR".
ode:status: "COMPLETED"
ode:statusDetail
Esto muestra más detalles, como sparkJobId y batchID si el estado es "PROCESANDO" o "INGIRIENDO". Muestra los detalles del error si el estado es "ERROR".

Pasos siguientes next-steps

Siguiendo esta guía de API, ha comprobado el estado de la carga de trabajo y ha enviado ofertas utilizando la API de Batch Decisioning. Para obtener más información, consulte la descripción general de Administración de decisiones.

recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76