Personalizar las notificaciones push

Requisitos previos

Antes de poder utilizar esta característica, tendrás que integrar el SDK de Braze para Android. También tendrás que configurar las notificaciones push.

Uso de una devolución de llamada para eventos push

Braze proporciona una devolución de llamada subscribeToPushNotificationEvents() para cuando se reciben, abren o descartan notificaciones push. Se recomienda colocar esta devolución de llamada en tu Application.onCreate() para no perderte ningún evento que ocurra mientras tu aplicación no se esté ejecutando.

Nota

Si antes utilizabas un receptor de difusión personalizado para esta funcionalidad en tu aplicación, puedes eliminarlo sin problemas en favor de esta opción de integración.

• java
• kotlin

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

Braze.getInstance(context).subscribeToPushNotificationEvents(event -> {
  final BrazeNotificationPayload parsedData = event.getNotificationPayload();

  //
  // The type of notification itself
  //
  final boolean isPushOpenEvent = event.getEventType() == BrazePushEventType.NOTIFICATION_OPENED;
  final boolean isPushReceivedEvent = event.getEventType() == BrazePushEventType.NOTIFICATION_RECEIVED;
  // Sent when a user has dismissed a notification
  final boolean isPushDeletedEvent = event.getEventType() == BrazePushEventType.NOTIFICATION_DELETED;

  //
  // Notification data
  //
  final String pushTitle = parsedData.getTitleText();
  final Long pushArrivalTimeMs = parsedData.getNotificationReceivedTimestampMillis();
  final String deeplink = parsedData.getDeeplink();

  //
  // Custom KVP data
  //
  final String myCustomKvp1 = parsedData.getBrazeExtras().getString("my first kvp");
  final String myCustomKvp2 = parsedData.getBrazeExtras().getString("my second kvp");
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

Braze.getInstance(context).subscribeToPushNotificationEvents { event ->
    val parsedData = event.notificationPayload

    //
    // The type of notification itself
    //
    val isPushOpenEvent = event.eventType == BrazePushEventType.NOTIFICATION_OPENED
    val isPushReceivedEvent = event.eventType == BrazePushEventType.NOTIFICATION_RECEIVED
    // Sent when a user has dismissed a notification
    val isPushDeletedEvent = event.eventType == BrazePushEventType.NOTIFICATION_DELETED

    //
    // Notification data
    //
    val pushTitle = parsedData.titleText
    val pushArrivalTimeMs = parsedData.notificationReceivedTimestampMillis
    val deeplink = parsedData.deeplink

    //
    // Custom KVP data
    //
    val myCustomKvp1 = parsedData.brazeExtras.getString("my first kvp")
    val myCustomKvp2 = parsedData.brazeExtras.getString("my second kvp")
}

Consejo

Con los botones de acción de notificación, las intenciones BRAZE_PUSH_INTENT_NOTIFICATION_OPENED se disparan cuando se hace clic en los botones con acciones opens app o deep link. El tratamiento de los vínculos profundos y los extras sigue siendo el mismo. Los botones con acciones close no disparan las intenciones BRAZE_PUSH_INTENT_NOTIFICATION_OPENED y descartan la notificación automáticamente.

Importante

Crea tu receptor de notificaciones push en Application.onCreate para asegurarte de que se desencadena cuando un usuario final toca una notificación mientras tu aplicación está en estado finalizado.

Personalización de la visualización de notificaciones

Paso 1: Crea tu fábrica de notificaciones personalizada

En algunos casos, es posible que desees personalizar las notificaciones push de formas que serían engorrosas o no estarían disponibles en el servidor. Para darte un control completo de la visualización de notificaciones, hemos añadido la posibilidad de definir tu propia IBrazeNotificationFactory para crear objetos de notificación que Braze mostrará.

Si se configura un IBrazeNotificationFactory personalizado, Braze llamará al método createNotification() de tu fábrica tras la recepción push antes de que se muestre la notificación al usuario. Braze pasará un Bundle que contiene datos push de Braze y otro Bundle que contiene pares clave-valor personalizados enviados a través del panel o de las API de mensajería:

Braze pasará un BrazeNotificationPayload que contiene los datos de la notificación push de Braze.

• java
• kotlin

1
2
3
4
5
6
7
8
9

// Factory method implemented in your custom IBrazeNotificationFactory
@Override
public Notification createNotification(BrazeNotificationPayload brazeNotificationPayload) {
  // Example of getting notification title
  String title = brazeNotificationPayload.getTitleText();

  // Example of retrieving a custom KVP ("my_key" -> "my_value")
  String customKvp = brazeNotificationPayload.getBrazeExtras().getString("my_key");
}

1
2
3
4
5
6
7
8

// Factory method implemented in your custom IBrazeNotificationFactory
override fun createNotification(brazeNotificationPayload: BrazeNotificationPayload): Notification {
  // Example of getting notification title
  val title = brazeNotificationPayload.getTitleText()

  // Example of retrieving a custom KVP ("my_key" -> "my_value")
  val customKvp = brazeNotificationPayload.getBrazeExtras().getString("my_key")
}

Puedes devolver null desde tu método personalizado createNotification() para no mostrar la notificación en absoluto, utilizar BrazeNotificationFactory.getInstance().createNotification() para obtener nuestro objeto predeterminado notification para esos datos y modificarlo antes de mostrarlo, o generar un objeto notification completamente independiente para mostrarlo.

Nota

Para obtener documentación sobre las claves de datos push de Braze, consulta el SDK de Android.

Paso 2: Configura tu fábrica de notificaciones personalizada

Para indicar a Braze que utilice tu fábrica de notificaciones personalizada, utiliza el método setCustomBrazeNotificationFactory para configurar tu IBrazeNotificationFactory:

• java
• kotlin

1

setCustomBrazeNotificationFactory(IBrazeNotificationFactory brazeNotificationFactory);

1

setCustomBrazeNotificationFactory(brazeNotificationFactory: IBrazeNotificationFactory)

El lugar recomendado para configurar tu IBrazeNotificationFactory personalizado es el método de ciclo de vida de la aplicación Application.onCreate() (no la actividad). Esto permitirá que la fábrica de notificaciones se configure correctamente siempre que el proceso de tu aplicación esté activo.

Importante

Crear tu propia notificación desde cero es un caso de uso avanzado y solo debe hacerse con pruebas exhaustivas y un conocimiento profundo de la funcionalidad push de Braze. Por ejemplo, debes asegurarte de que tu notificación registre correctamente las aperturas push.

Para desactivar tu IBrazeNotificationFactory personalizado y volver a la gestión predeterminada de Braze para push, pasa null al configurador de fábrica de notificaciones personalizadas:

• java
• kotlin

1

setCustomBrazeNotificationFactory(null);

1

setCustomBrazeNotificationFactory(null)

Renderizar texto multicolor

En la versión 3.1.1 del SDK de Braze, se puede enviar HTML a un dispositivo para renderizar texto multicolor en las notificaciones push.

Este ejemplo se renderiza con el siguiente HTML:

1
2
3

<p><span style="color: #99cc00;">M</span>u<span style="color: #008080;">lti</span>Colo<span style="color: #ff6600;">r</span> <span style="color: #000080;">P</span><span style="color: #00ccff;">u</span><span style="color: #ff0000;">s</span><span style="color: #808080;">h</span></p>

<p><em>test</em> <span style="text-decoration: underline; background-color: #ff6600;"><strong>message</strong></span></p>

Ten en cuenta que Android limita qué elementos y etiquetas HTML son válidos en tus notificaciones push. Por ejemplo, marquee no está permitido.

Importante

La renderización de texto multicolor es específica del dispositivo y puede no mostrarse dependiendo del dispositivo o la versión de Android.

Para renderizar texto multicolor en una notificación push, puedes actualizar tu braze.xml o BrazeConfig:

• braze.xml
• brazeconfig

1

<bool translatable="false" name="com_braze_push_notification_html_rendering_enabled">true</bool>

1
2
3
4

BrazeConfig brazeConfig = new BrazeConfig.Builder()
  .setPushHtmlRenderingEnabled(true)
  .build();
Braze.configure(this, brazeConfig);

1
2
3
4

val brazeConfig = BrazeConfig.Builder()
    .setPushHtmlRenderingEnabled(true)
    .build()
Braze.configure(this, brazeConfig)

Etiquetas HTML compatibles

Actualmente, Google no enumera directamente en su documentación las etiquetas HTML compatibles con Android—esta información solo se puede encontrar en el archivo Html.java de su repositorio Git. Ten esto en cuenta al consultar la siguiente tabla, ya que esta información se extrajo de ese archivo y las etiquetas HTML compatibles podrían cambiar.

Renderizado de imágenes en línea

Cómo funciona

Puedes mostrar una imagen más grande dentro de tu notificación push de Android usando push con imagen en línea. Con este diseño, los usuarios no tendrán que expandir manualmente la push para ampliar la imagen. A diferencia de las notificaciones push estándar de Android, las imágenes de push con imagen en línea tienen una relación de aspecto de 3:2.

Compatibilidad

Aunque puedes enviar imágenes en línea a cualquier dispositivo, los dispositivos y SDK que no cumplan con las versiones mínimas mostrarán una imagen estándar en su lugar. Para que las imágenes en línea se muestren correctamente, se requiere tanto el SDK de Braze para Android v10.0.0+ como un dispositivo con Android M+. El SDK también debe estar habilitado para que la imagen se renderice.

Nota

Los dispositivos con Android 12 se renderizarán de manera diferente debido a cambios en los estilos personalizados de notificaciones push.

Enviar una push con imagen en línea

Al crear un mensaje push de Android, esta característica está disponible en el menú desplegable Notification Type.

Configuración

Hay muchas configuraciones avanzadas disponibles para las notificaciones push de Android enviadas a través del panel de Braze. Este artículo describirá estas características y cómo usarlas con éxito.

ID de notificación

Un ID de notificación es un identificador único para una categoría de mensaje de tu elección que indica al servicio de mensajería que solo respete el mensaje más reciente de ese ID. Establecer un ID de notificación te permite enviar solo el mensaje más reciente y relevante, en lugar de una pila de mensajes obsoletos e irrelevantes.

Evitar que notificaciones duplicadas se sobrescriban

De forma predeterminada, cuando las notificaciones push tienen títulos y texto del cuerpo idénticos, Android genera el mismo ID de notificación para ambos mensajes haciendo un hash del título y las cadenas del cuerpo juntos. Esto hace que la segunda notificación sobrescriba la primera, lo que resulta en que solo aparezca una única notificación en la bandeja de notificaciones.

Para evitar que las notificaciones idénticas se sobrescriban entre sí, puedes especificar valores únicos de ID de notificación en la configuración de tus notificaciones push de Android. Aquí tienes algunas opciones:

• Usa plantillas Liquid con marca de tiempo: Genera un valor único basado en la hora actual.

1
2

{% assign random_number = 'now' | date: '%s' | plus: 1000000 %}
{{random_number}}

• Generación del lado del servidor: Para valores verdaderamente aleatorios, genera el ID de notificación en tu servidor y pásalo a través de Liquid. Esto garantiza que cada notificación tenga un identificador distinto, lo que permite que múltiples notificaciones se muestren simultáneamente.

Prioridad de entrega de Firebase Messaging

El campo de prioridad de entrega de Firebase Messaging te permite controlar si un push se envía con prioridad “normal” o “alta” a Firebase Cloud Messaging.

Tiempo de vida (TTL)

El campo de tiempo de vida (TTL) te permite establecer una duración personalizada para almacenar mensajes con el servicio de mensajería push. Los valores predeterminados del tiempo de vida son cuatro semanas para FCM y 31 días para ADM.

Texto de resumen

El texto de resumen te permite establecer texto adicional en la vista expandida de la notificación. También sirve como pie de foto para notificaciones con imágenes.

El texto de resumen se mostrará debajo del cuerpo del mensaje en la vista expandida.

Para las notificaciones push que incluyen imágenes, el texto del mensaje se mostrará en la vista contraída, mientras que el texto de resumen se mostrará como pie de foto de la imagen cuando la notificación esté expandida.

URI personalizados

La característica de URI personalizado te permite especificar una URL web o un recurso de Android al que navegar cuando se hace clic en la notificación. Si no se especifica un URI personalizado, al hacer clic en la notificación los usuarios entrarán en tu aplicación. Puedes usar el URI personalizado para crear vínculos profundos dentro de tu aplicación y dirigir a los usuarios a recursos que existen fuera de tu aplicación. Esto se puede especificar a través de la API de mensajería o en nuestro panel en Configuración avanzada en el creador de push, como se muestra:

Prioridad de visualización de la notificación

Importante

La configuración de prioridad de visualización de la notificación ya no se utiliza en dispositivos que ejecutan Android O o versiones más recientes. Para dispositivos más nuevos, establece la prioridad a través de la configuración de canal de notificación.

El nivel de prioridad de una notificación push afecta cómo se muestra tu notificación en la bandeja de notificaciones en relación con otras notificaciones. También puede afectar la velocidad y el modo de entrega, ya que los mensajes de prioridad normal e inferior pueden enviarse con una latencia ligeramente mayor o agruparse para preservar la vida de la batería, mientras que los mensajes de alta prioridad siempre se envían de inmediato.

En Android O, la prioridad de la notificación se convirtió en una propiedad de los canales de notificación. Necesitarás trabajar con tu desarrollador para definir la prioridad de un canal durante su configuración y luego usar el panel para seleccionar el canal adecuado al enviar los sonidos de tus notificaciones. Para dispositivos que ejecutan versiones de Android anteriores a O, es posible especificar un nivel de prioridad para las notificaciones de Android a través del panel de Braze y la API de mensajería.

Para enviar mensajes a toda tu base de usuarios con una prioridad específica, te recomendamos que especifiques indirectamente la prioridad a través de la configuración de canal de notificación (para dispositivos O+) y envíes la prioridad individual desde el panel (para dispositivos <O).

Los niveles de prioridad que puedes establecer en las notificaciones push de Android o Fire OS son:

Para más información, consulta la documentación de Google sobre notificaciones de Android.

Sonidos

En Android O, los sonidos de notificación se convirtieron en una propiedad de los canales de notificación. Necesitarás trabajar con tu desarrollador para definir el sonido de un canal durante su configuración y luego usar el panel para seleccionar el canal adecuado al enviar tus notificaciones.

Para dispositivos que ejecutan versiones de Android anteriores a O, Braze te permite establecer el sonido de un mensaje push individual a través del creador del panel. Puedes hacerlo especificando un recurso de sonido local en el dispositivo (por ejemplo, android.resource://com.mycompany.myapp/raw/mysound). Especificar “default” en este campo reproducirá el sonido de notificación predeterminado del dispositivo. Esto se puede especificar a través de la API de mensajería o en el panel en Configuración avanzada en el creador de push.

Ingresa el URI completo del recurso de sonido (por ejemplo, android.resource://com.mycompany.myapp/raw/mysound) en el campo del panel.

Para enviar mensajes a toda tu base de usuarios con un sonido específico, te recomendamos que especifiques indirectamente el sonido a través de la configuración de canal de notificación (para dispositivos O+) y envíes el sonido individual desde el panel (para dispositivos <O).