Skip to content

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 mensajería transaccional. Al crear campañas API (no campañas activadas por API), el panel de Braze solo 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 variante del mensaje, que es diferente para cada variante de tu campaña.

A continuación, envía esa información a tu equipo de desarrollo para que la utilice en la solicitud de API, junto con lo siguiente:

  • Texto de la campaña
  • Pertenencia a 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 de Braze, que tienen las mismas opciones detalladas de informes y reorientación que las campañas creadas completamente a través del panel.

Crear una nueva campaña

Ve a Mensajería > Campaigns y selecciona Crear Campaign, luego selecciona API Campaigns. Ahora puedes continuar con la configuración de tu campaña de API.

Una campaña activada por API es diferente de una campaña de API.

Configura tu campaña

Para configurar tu campaña, realiza los siguientes pasos:

  1. Añade un título descriptivo para que puedas encontrar los resultados en la página de Campaigns después de haber enviado tus mensajes.
  2. Selecciona Añadir mensaje y añade los tipos de mensaje incluidos en tu campaña de API. Esto te permite generar un campaign_id y un ID de variante de mensaje, que difiere para cada canal que incluyas.
  3. Opcionalmente, puedes añadir un evento de conversión para rastrear las conversiones de los usuarios en una acción o meta de campaña específica.
  4. Selecciona Guardar Campaign para comenzar tu campaña de API.

Llamadas a la API

Después de guardar tu campaña de API, incluye lo siguiente en tu solicitud de API:

  • Los campos campaign_id generados con tu solicitud de API donde se indica en los endpoints de envío de mensajes.
  • Un objeto de mensaje para cada plataforma incluida en la campaña. En el objeto de mensaje, proporciona el ID de variante del mensaje. Esto especifica que las estadísticas deben recopilarse y mostrarse bajo esa variante. Se admiten los siguientes objetos de mensaje: Android, Content Cards, correo electrónico, iOS, Kindle, SMS/MMS, notificación push web y webhook.

Añadir cancelación de suscripción con un clic a campañas de API

De forma predeterminada, Braze no añade el encabezado de cancelación de suscripción con un clic a las campañas de API. Puedes añadir este encabezado a envíos individuales de campañas de API incluyendo la etiqueta de Liquid {{${set_user_to_one_click_list_unsubscribe}}} en el campo de encabezados de correo electrónico de tu solicitud de API.

Para cumplir con RFC 8058 para la cancelación de suscripción con un clic, incluye los encabezados List-Unsubscribe y List-Unsubscribe-Post en tu solicitud de API:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{
  "external_user_ids": ["user_id"],
  "messages": {
    "email": {
      "app_id": "your_app_id",
      "subject": "Your Subject",
      "from": "Sender Name <[email protected]>",
      "body": "<p>Email body content</p>",
      "headers": {
        "List-Unsubscribe": "<{{${set_user_to_one_click_list_unsubscribe}}}>",
        "List-Unsubscribe-Post": "List-Unsubscribe=One-Click"
      }
    }
  }
}

Añadir archivos adjuntos de correo electrónico

Para añadir archivos adjuntos a los correos electrónicos de campañas de API, incluye un array attachments en el objeto de correo electrónico. Puedes hacer referencia a una plantilla de correo electrónico creada en el editor de arrastrar y soltar o en el editor HTML proporcionando su email_template_id en el objeto de correo electrónico y, a continuación, añadir archivos adjuntos a través de la llamada a la API.

Para obtener detalles sobre archivos adjuntos, límites de tamaño y prácticas recomendadas, consulta Ejemplo de objeto de correo electrónico con archivo adjunto.
New Stuff!