Campañas API
Este artículo de referencia explica cómo generar un
campaign_id
para incluirlo en tus llamadas a la API y cómo configurar esa campaña.
Las campañas de API suelen utilizarse para mensajes transaccionales. Al crear campañas API (no campañas desencadenadas por API), el panel de Braze sólo se utiliza para generar un campaign_id
, que te permite hacer un seguimiento de los análisis para los informes de campaña. También puedes generar un ID de variación del mensaje, que es diferente para cada variante de tu campaña.
A continuación, enviarás esa información a tu equipo de desarrollo para que la utilice en la solicitud de API, junto con lo siguiente:
- Texto de campaña
- Membresía de la audiencia
- Activos
Una vez iniciada la campaña, puedes ver los resultados en el panel. Las campañas API utilizan las API de mensajería Braze, que tienen las mismas opciones detalladas de informes y reorientación que las campañas creadas completamente a través del panel.
Como las campañas API suelen ser transaccionales, todos los usuarios son elegibles para las campañas API, incluso los de tu grupo de control global. En estos envíos no se añade un encabezado de cancelar suscripción con un clic. Si deseas añadir un encabezado de cancelación de suscripción con un solo clic a todas las campañas de API, ponte en contacto con tu administrador del éxito del cliente.
Crear una nueva campaña
Ve a Mensajería > Campañas y selecciona Crear campaña y, a continuación, Campañas API. Ahora, puedes avanzar para configurar tu campaña de API.
Una campaña desencadenada por API es diferente de una campaña de API.
Configura tu campaña
Para configurar tu campaña, realiza los siguientes pasos:
- Añade un título descriptivo para que puedas encontrar los resultados en nuestra página de campañas después de haber enviado tus mensajes.
- Haz clic en Añadir mensaje y añade los tipos de mensajes que se incluirán en tu campaña API. Esto te permitirá generar un
campaign_id
y un ID de variación del mensaje, que difiere para cada canal que incluyas. - Opcionalmente, puedes añadir un evento de conversión para hacer un seguimiento de las conversiones de usuarios en una acción específica o en un objetivo de campaña.
- Haz clic en Guardar campaña y ¡ya estás listo para empezar tu campaña API!
Llamadas a la API
Después de guardar tu campaña de API incluye lo siguiente en tu solicitud API:
- Los campos
campaign_id
generados con tu solicitud API según se haya indicado en los puntos finales Enviar mensajes. - Un objeto de mensaje para cada plataforma incluida en la campaña. En el objeto mensaje, proporciona el ID de variación del mensaje. Esto especificará que las estadísticas deben recopilarse y mostrarse bajo esa variante. Se admiten los siguientes objetos de mensaje: Android, tarjetas de contenido, correo electrónico, iOS, Kindle, SMS/MMS, notificación push web y webhook.