(Beta) Activar segmentos de audiencia en destinos por lotes mediante la API de activación ad hoc

IMPORTANTE

La variable ad-hoc activation API en Platform se encuentra en versión beta. La documentación y las funciones están sujetas a cambios.

Información general

La API de activación ad hoc permite a los especialistas en marketing activar mediante programación segmentos de audiencia en destinos de forma rápida y eficaz en situaciones en las que se requiera una activación inmediata.

El diagrama siguiente ilustra el flujo de trabajo completo para activar segmentos mediante la API de activación ad hoc, incluidos los trabajos de segmentación que se realizan en Platform cada 24 horas.

activación ad hoc

NOTA

La activación de audiencias ad-hoc solo es compatible con destinos basados en archivos por lotes.

Casos de uso

Ventas o promociones de Flashes

Un minorista en línea está preparando una venta flash limitada y quiere notificar a los clientes con un breve aviso. A través de la API de activación ad hoc del Experience Platform, el equipo de marketing puede exportar segmentos bajo demanda y enviar rápidamente correos electrónicos promocionales a la base de clientes.

Eventos actuales o noticias de último minuto

Un hotel espera que el tiempo sea inclemente en los próximos días, y el equipo quiere informar a los clientes rápidamente, para que puedan planear en consecuencia. El equipo de marketing puede utilizar la API de activación ad hoc de Experience Platform para exportar segmentos bajo demanda y notificar a los clientes.

Pruebas de integración

Los administradores de TI pueden utilizar la API de activación ad hoc del Experience Platform para exportar segmentos bajo demanda, de modo que puedan probar su integración personalizada con Adobe Experience Platform y asegurarse de que todo funciona correctamente.

Seguridad

Tenga en cuenta las siguientes limitaciones al utilizar la API de activación ad hoc.

  • Actualmente, cada trabajo de activación ad-hoc puede activar hasta 20 segmentos. Si se intentan activar más de 20 segmentos por trabajo, el trabajo fallará. Este comportamiento está sujeto a cambios en futuras versiones.
  • Los trabajos de activación específicos no se pueden ejecutar en paralelo con los programados trabajos de exportación de segmentos. Antes de ejecutar un trabajo de activación ad-hoc, asegúrese de que el trabajo de exportación de segmentos programado haya finalizado. Consulte control de flujo de datos de destino para obtener información sobre cómo monitorizar el estado de los flujos de activación. Por ejemplo, si el flujo de datos de activación muestra un Procesamiento espera a que finalice antes de ejecutar el trabajo de activación ad hoc.
  • No ejecute más de un trabajo de activación ad hoc concurrente por segmento.

Consideraciones sobre la segmentación

Adobe Experience Platform ejecuta trabajos de segmentación programados una vez cada 24 horas. La API de activación ad hoc se ejecuta en función de los resultados de segmentación más recientes.

Paso 1: Requisitos previos

Antes de realizar llamadas a las API de Adobe Experience Platform, asegúrese de cumplir los siguientes requisitos previos:

  • Tiene una cuenta de organización de IMS con acceso a Adobe Experience Platform.
  • Su cuenta de Experience Platform tiene la variable developer y user funciones habilitadas para el perfil de producto de la API de Adobe Experience Platform. Póngase en contacto con su Admin Console para habilitar estas funciones en su cuenta.
  • Tiene un Adobe ID. Si no tiene un Adobe ID, vaya a la sección Adobe Developer Console y cree una cuenta nueva.

Paso 2: Recopilar credenciales

Para realizar llamadas a las API de Platform, primero debe completar la variable tutorial de autenticación. Al completar el tutorial de autenticación, se proporcionan los valores para cada uno de los encabezados necesarios en todas las llamadas a la API de Experience Platform, como se muestra a continuación:

  • Autorización: Portador {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Los recursos del Experience Platform se pueden aislar en entornos limitados virtuales específicos. En las solicitudes a las API de plataforma, puede especificar el nombre y el ID del simulador de pruebas en el que se realizará la operación. Son parámetros opcionales.

  • x-sandbox-name: {SANDBOX_NAME}
NOTA

Para obtener más información sobre los entornos limitados en el Experience Platform, consulte la documentación general de entorno limitado.

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

  • Content-Type: application/json

Paso 3: Crear flujo de activación en la interfaz de usuario de Platform

Para poder activar segmentos a través de la API de activación ad hoc, primero debe tener configurado un flujo de activación en la interfaz de usuario de Platform para el destino elegido.

Esto incluye entrar en el flujo de trabajo de activación, seleccionar los segmentos, configurar una programación y activarlos.

Consulte el siguiente tutorial para obtener instrucciones detalladas sobre cómo configurar un flujo de activación para los destinos de lote: Activar datos de audiencia en destinos de exportación de perfiles en lote.

Paso 4: Obtenga el último ID de trabajo de exportación de segmentos

Después de configurar el flujo de activación para el destino por lotes, los trabajos de segmentación programados empiezan a ejecutarse automáticamente cada 24 horas.

Para poder ejecutar el trabajo de activación ad-hoc, debe obtener el ID del trabajo de exportación de segmentos más reciente. Debe pasar este ID en la solicitud de trabajo de activación ad hoc.

Siga las instrucciones descritas here para recuperar una lista de todos los trabajos de exportación de segmentos.

En la respuesta, busque el primer registro que incluye la propiedad schema a continuación.

"schema":{
   "name":"_xdm.context.profile"
}

El ID del trabajo de exportación de segmentos se encuentra en la variable id como se muestra a continuación.

ID de trabajo de exportación de segmentos

Paso 5: Ejecutar el trabajo de activación ad hoc

Adobe Experience Platform ejecuta trabajos de segmentación programados una vez cada 24 horas. La API de activación ad hoc se ejecuta en función de los resultados de segmentación más recientes.

Antes de ejecutar un trabajo de activación ad-hoc, asegúrese de que el trabajo de exportación de segmentos programado para sus segmentos haya finalizado. Consulte control de flujo de datos de destino para obtener información sobre cómo monitorizar el estado de los flujos de activación. Por ejemplo, si el flujo de datos de activación muestra un Procesamiento espera a que finalice antes de ejecutar el trabajo de activación ad hoc.

Una vez completado el trabajo de exportación de segmentos, puede almacenar en déclencheur la activación.

NOTA

Actualmente, cada trabajo de activación ad-hoc puede activar hasta 20 segmentos. Si se intentan activar más de 20 segmentos por trabajo, el trabajo fallará. Este comportamiento está sujeto a cambios en futuras versiones.

Solicitud

curl -X POST https://platform.adobe.io/data/core/activation/disflowprovider/adhocrun \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -d '
{
   "activationInfo":{
      "destinationId1":[
         "segmentId1",
         "segmentId2"
      ],
      "destinationId2":[
         "segmentId2",
         "segmentId3"
      ]
   },
   "exportIds":[
      "exportId1"
   ]
}
Propiedad Descripción
  • destinationId1
  • destinationId2
ID de las instancias de destino en las que desea activar segmentos.
  • segmentId1
  • segmentId2
  • segmentId3
ID de los segmentos que desea activar en el destino seleccionado.
  • exportId1
El ID devuelto en la respuesta del exportación de segmentos trabajo. Consulte Paso 4: Obtenga el último ID de trabajo de exportación de segmentos para obtener instrucciones sobre cómo encontrar este ID.

Respuesta

Una respuesta correcta devuelve el estado HTTP 200.

{
   "order":[
      {
         "segment":"db8961e9-d52f-45bc-b3fb-76d0382a6851",
         "order":"ef2dcbd6-36fc-49a3-afed-d7b8e8f724eb",
         "statusURL":"https://platform.adobe.io/data/foundation/flowservice/runs/88d6da63-dc97-460e-b781-fc795a7386d9"
      }
   ]
}
Propiedad Descripción
segment ID del segmento activado.
order ID del destino en el que se activó el segmento.
statusURL La URL de estado del flujo de activación. Puede realizar un seguimiento del progreso del flujo mediante la API del servicio de flujo.

Gestión de errores de API

Los extremos de la API del Destination SDK siguen los principios generales del mensaje de error de la API del Experience Platform. Consulte Códigos de estado de API y errores en el encabezado de la solicitud en la guía de solución de problemas de Platform.

En esta página