Después de completar la fase beta, el ad-hoc activation API ahora está disponible de forma general (GA) para todos los clientes de Experience Platform. En la versión de GA, la API se ha actualizado a la versión 2. Paso 4 (Obtenga el ID de trabajo de exportación de audiencia más reciente) ya no es necesaria, ya que la API ya no requiere el ID de exportación.
Consulte Ejecutar el trabajo de activación ad hoc más abajo en este tutorial para obtener más información.
La API de activación ad-hoc permite a los especialistas en marketing activar audiencias de audiencia a destinos mediante programación de forma rápida y eficaz en situaciones en las que se requiera la activación inmediata.
Utilice la API de activación ad-hoc para exportar archivos completos al sistema de recepción de archivos deseado. La activación de audiencias ad hoc solo es compatible con destinos basados en archivos por lotes.
El diagrama siguiente ilustra el flujo de trabajo completo para activar audiencias a través de la API de activación ad-hoc, incluidos los trabajos de segmentación que se realizan en Platform cada 24 horas.
Un minorista en línea está preparando una venta flash limitada y quiere avisar a los clientes con poco tiempo de antelación. A través de la API de activación ad hoc de Experience Platform, el equipo de marketing puede exportar audiencias bajo demanda y enviar rápidamente correos electrónicos promocionales a la base de clientes.
Un hotel espera un tiempo inclemente en los próximos días, y el equipo quiere informar a los huéspedes que llegan rápidamente, para que puedan planificar en consecuencia. El equipo de marketing puede utilizar la API de activación ad-hoc de Experience Platform para exportar audiencias bajo demanda y notificar a los invitados.
Los administradores de TI pueden utilizar la API de activación ad hoc de Experience Platform para exportar audiencias bajo demanda, de modo que puedan probar su integración personalizada con Adobe Experience Platform y asegurarse de que todo funciona correctamente.
Tenga en cuenta las siguientes protecciones al utilizar la API 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.
Para poder realizar llamadas a las API de Adobe Experience Platform, asegúrese de cumplir los siguientes requisitos previos:
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.Para realizar llamadas a las API de Platform, primero debe completar el tutorial de autenticación. Al completar el tutorial de autenticación, se proporcionan los valores de cada uno de los encabezados necesarios en todas las llamadas a la API de Experience Platform, como se muestra a continuación:
{ACCESS_TOKEN}
{API_KEY}
{ORG_ID}
Los recursos de Experience Platform se pueden aislar en zonas protegidas virtuales específicas. En las solicitudes a las API de Platform, puede especificar el nombre y el ID de la zona protegida en la que se realizará la operación. Son parámetros opcionales.
{SANDBOX_NAME}
Para obtener más información sobre los entornos limitados de Experience Platform, consulte la documentación general de zona protegida.
Todas las solicitudes que contienen una carga útil (POST, PUT, PATCH) requieren un encabezado de tipo de medios adicional:
application/json
Para poder activar audiencias 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 las audiencias, configurar una programación y activarlas. Puede utilizar la interfaz de usuario o la API de para crear un flujo de activación:
En la versión 2 de la API de activación ad-hoc, no es necesario obtener el ID de trabajo de exportación de audiencia más reciente. Puede omitir este paso y continuar con el siguiente.
Después de configurar un flujo de activación para el destino del lote, los trabajos de segmentación programados comienzan a ejecutarse automáticamente cada 24 horas.
Para poder ejecutar el trabajo de activación ad-hoc, debe obtener el ID del último trabajo de exportación de audiencias. Debe pasar este ID en la solicitud de trabajo de activación ad-hoc.
Siga las instrucciones descritas aquí para recuperar una lista de todos los trabajos de exportación de audiencia.
En la respuesta, busque el primer registro que incluya la propiedad de esquema a continuación.
"schema":{
"name":"_xdm.context.profile"
}
El ID del trabajo de exportación de audiencia se encuentra en id
, como se muestra a continuació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.
Tenga en cuenta la siguiente restricción de una sola vez: antes de ejecutar un trabajo de activación ad-hoc, asegúrese de que han transcurrido al menos 20 minutos desde el momento en que la audiencia se activó por primera vez según la programación establecida en Paso 3: Creación de un flujo de activación en la interfaz de usuario de Platform.
Antes de ejecutar un trabajo de activación ad-hoc, asegúrese de que el trabajo de exportación de audiencias programado para sus audiencias haya finalizado. Consulte monitorización del 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 Procesando estado, espere a que finalice antes de ejecutar el trabajo de activación ad-hoc para exportar un archivo completo.
Una vez completado el trabajo de exportación de audiencias, puede almacenar la activación en déclencheur.
Actualmente, cada trabajo de activación ad-hoc puede activar hasta 80 audiencias. Si se intentan activar más de 80 audiencias por trabajo, el trabajo fallará. Este comportamiento está sujeto a cambios en futuras versiones.
Es obligatorio incluir la variable Accept: application/vnd.adobe.adhoc.activation+json; version=2
en la solicitud para utilizar la versión 2 de la API de activación ad-hoc.
curl --location --request POST 'https://platform.adobe.io/data/core/activation/disflowprovider/adhocrun' \
--header 'x-gw-ims-org-id: 5555467B5D8013E50A494220@AdobeOrg' \
--header 'Authorization: Bearer {{token}}' \
--header 'x-sandbox-id: 6ef74723-3ee7-46a4-b747-233ee7a6a41a' \
--header 'x-sandbox-name: {sandbox-id}' \
--header 'Accept: application/vnd.adobe.adhoc.activation+json; version=2' \
--header 'Content-Type: application/json' \
--data-raw '{
"activationInfo":{
"destinationId1":[
"segmentId1",
"segmentId2"
],
"destinationId2":[
"segmentId2",
"segmentId3"
]
}
}'
Propiedad | Descripción |
---|---|
|
Los ID de las instancias de destino en las que desea activar audiencias. Puede obtener estos ID desde la interfaz de usuario de Platform navegando hasta Destinos > Examinar y haciendo clic en la fila de destino deseada para que aparezca el ID de destino en el carril derecho. Para obtener más información, lea la documentación de destinos workspace. |
|
Los ID de las audiencias que desea activar en el destino seleccionado. |
Tipo de solicitud obsoleta. Este tipo de ejemplo describe el tipo de solicitud de la API versión 1. En la versión 2 de la API de activación ad-hoc, no es necesario incluir el ID de trabajo de exportación de audiencia más reciente.
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: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-d '
{
"activationInfo":{
"destinationId1":[
"segmentId1",
"segmentId2"
],
"destinationId2":[
"segmentId2",
"segmentId3"
]
},
"exportIds":[
"exportId1"
]
}
Propiedad | Descripción |
---|---|
|
Los ID de las instancias de destino en las que desea activar audiencias. Puede obtener estos ID desde la interfaz de usuario de Platform navegando hasta Destinos > Examinar y haciendo clic en la fila de destino deseada para que aparezca el ID de destino en el carril derecho. Para obtener más información, lea la documentación de destinos workspace. |
|
Los ID de las audiencias que desea activar en el destino seleccionado. |
|
El ID devuelto en la respuesta de exportación de audiencia trabajo. Consulte Paso 4: Obtención del ID de trabajo de exportación de audiencia más reciente para obtener instrucciones sobre cómo encontrar este ID. |
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 |
El ID de la audiencia activada. |
order |
El ID del destino en el que se activó la audiencia. |
statusURL |
La URL de estado del flujo de activación. Puede realizar un seguimiento del progreso del flujo mediante la variable API de Flow Service. |
Los extremos de la API de Destination SDK siguen los principios generales del mensaje de error de la API de Experience Platform. Consulte Códigos de estado de API y errores de encabezado de solicitud en la guía de solución de problemas de Platform.
Al utilizar la API de activación ad hoc, puede encontrar mensajes de error específicos de este extremo de API. Revise la tabla para comprender cómo abordarlos cuando aparecen.
Mensaje de error | Resolución |
---|---|
La ejecución ya está en marcha para la audiencia segment ID para pedido dataflow ID con id de ejecución flow run ID |
Este mensaje de error indica que hay un flujo de activación ad-hoc en curso para una audiencia. Espere a que finalice el trabajo antes de volver a activar el trabajo de activación. |
Segmentos <segment name> no forman parte de este flujo de datos o están fuera del intervalo programado. |
Este mensaje de error indica que las audiencias que seleccionó para activar no están asignadas al flujo de datos o que la programación de activación configurada para las audiencias ha caducado o aún no se ha iniciado. Compruebe si la audiencia está realmente asignada al flujo de datos y que la programación de activación de audiencia se superpone con la fecha actual. |