Personnaliser les notifications push

Conditions préalables

Avant de pouvoir utiliser cette fonctionnalité, vous devrez intégrer le SDK Android Braze. Il vous sera également nécessaire de configurer les notifications push.

Utilisation d’un rappel pour les événements push

Braze propose une fonction de rappel subscribeToPushNotificationEvents() pour la réception, l’ouverture ou le rejet des notifications push. Nous vous recommandons de placer cette fonction de rappel dans votre Application.onCreate() pour ne manquer aucun événement survenant lorsque votre application n’est pas en fonctionnement.

• 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")
}

Personnalisation de l’affichage des notifications personnalisées

Étape 1 : Créer votre fabrique de notification personnalisée

Dans certains scénarios, vous pourriez désirer personnaliser les notifications push d’une manière qui pourrait être encombrante ou non disponible côté serveur. Pour vous donner un contrôle complet de l’affichage des notifications, nous avons ajouté la possibilité de définir vos propres objets de notification. IBrazeNotificationFactory pour créer des objets de notification qui seront affichés par Braze.

Si une IBrazeNotificationFactory personnalisée est définie, Braze appellera la méthode createNotification() de votre fabrique lors de la réception de la notification push avant qu’elle ne soit affichée à l’utilisateur. Braze transmettra un Bundle contenant les données de notification push Braze et un autre Bundle contenant les paires clé-valeur personnalisées envoyées soit via le tableau de bord soit par les API de messagerie :

Braze transmettra un fichier BrazeNotificationPayload contenant les données de la notification 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")
}

Vous pouvez renvoyer null à partir de votre méthode createNotification() personnalisée pour ne pas afficher du tout la notification, utiliser BrazeNotificationFactory.getInstance().createNotification() pour obtenir notre objet notification par défaut pour ces données et le modifier avant l’affichage, ou générer un objet notification complètement séparé pour l’affichage.

Étape 2 : Définir votre fabrique de notification personnalisée

Pour demander à Braze d’utiliser votre fabrique de notification personnalisée, utilisez la méthode setCustomBrazeNotificationFactory afin de définir votre IBrazeNotificationFactory :

• java
• kotlin

1
setCustomBrazeNotificationFactory(IBrazeNotificationFactory brazeNotificationFactory);

1
setCustomBrazeNotificationFactory(brazeNotificationFactory: IBrazeNotificationFactory)

L’endroit recommandé pour définir votre IBrazeNotificationFactory personnalisée est dans la méthode de cycle de vie de l’application Application.onCreate() (pas activité). Cela permettra à la fabrique de notification d’être correctement définie chaque fois que le processus de votre application est actif.

Pour annuler la définition de votre IBrazeNotificationFactory personnalisée et revenir à la gestion par défaut de Braze pour les notifications push, transmettez null à notre système de définition de fabrique de notification personnalisée :

• java
• kotlin

1
setCustomBrazeNotificationFactory(null);

1
setCustomBrazeNotificationFactory(null)

Affichage de texte multicolore

Dans le SDK Braze version 3.1.1, du HTML peut être envoyé à un appareil pour afficher du texte multicolore dans les notifications push.

Cet exemple est affiché avec le code HTML suivant :

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>

Veuillez noter qu’Android impose des restrictions sur les éléments et tags HTML autorisés dans vos notifications push. Par exemple, marquee n’est pas autorisé.

Pour afficher du texte multicolore dans une notification push, vous pouvez mettre à jour votrebraze.xml ou 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)

Balises HTML prises en charge

Actuellement, Google ne répertorie pas les tags HTML pris en charge pour Android directement dans sa documentation. Ces informations ne sont disponibles que dans le fichierHtml.java de son dépôt Git. Veuillez garder cela à l’esprit lorsque vous consultez le tableau suivant, car ces informations proviennent de ce fichier et les tags HTML pris en charge sont susceptibles d’être modifiés.

Rendu des images en ligne

Fonctionnement

Vous pouvez afficher une image plus grande dans votre notification push Android à l’aide de la fonctionnalité « inline image push ». Avec cette conception, les utilisateurs n’auront pas à étendre manuellement la notification push pour agrandir l’image. Contrairement aux notifications push standard pour Android, les images des notifications push d’image insérée ont un rapport hauteur/largeur de 3:2.

Compatibilité

Bien que vous puissiez envoyer des images intégrées à n’importe quel appareil, les appareils et SDK qui ne répondent pas aux versions minimales requises afficheront une image standard à la place. Pour que les images intégrées s’affichent correctement, il est nécessaire de disposer à la fois du SDK Android Braze v10.0.0+ et d’un appareil fonctionnant sous Android M+. Le SDK doit également être activé pour que l’image puisse être affichée.

Envoi d’une image intégrée

Lors de la création d’un message push Android, cette fonctionnalité est disponible dans le menu déroulant Type de notification.

Paramètres

Il existe de nombreux paramètres avancés disponibles pour les notifications push Android envoyées via le tableau de bord de Braze. Le présent article décrit ces fonctionnalités et la manière de les utiliser avec succès.

ID de notification

Un ID de notification est un identifiant unique pour une catégorie de message de votre choix qui informe le service de messagerie de ne respecter que le message le plus récent de cet ID. Définir un ID de notification vous permet d’envoyer uniquement le message le plus récent et le plus pertinent, plutôt qu’une pile de données obsolètes et non pertinentes.

Priorité de livraison d’envoi de message Firebase

Le champ Priorité d’envoi/distribution de la messagerie Firebase vous permet de contrôler si un push est envoyé avec une priorité “normale” ou “élevée” à la messagerie Firebase Cloud.

TTL (Durée de vie)

Le champ Durée en vie (TTL) vous permet de définir une durée personnalisée de stockage des messages avec le service de messagerie push. Les valeurs par défaut pour la durée de vie sont de quatre semaines pour FCM et de 31 jours pour ADM.

Texte récapitulatif

Le texte récapitulatif vous permet de définir un texte supplémentaire dans la vue de notification étendue. Il sert également de légende pour les notifications avec des images.

Le texte récapitulatif s’affiche sous le corps du message dans la vue étendue.

Pour les notifications push qui incluent des images, le texte du message s’affiche dans la vue réduite tandis que le texte récapitulatif s’affiche comme légende d’image lorsque la notification est étendue.

URI personnalisés

La fonctionnalité URI personnalisé vous permet de spécifier une URL Web ou une ressource Android vers laquelle naviguer lorsque l’on clique sur la notification. Si aucun URI personnalisé n’est spécifié, cliquer sur la notification amène les utilisateurs dans votre application. Vous pouvez utiliser l’URI personnalisé pour créer un lien profond à l’intérieur de votre application et diriger les utilisateurs vers des ressources qui existent en dehors de votre application. Ceci peut être spécifié via l’API Messages ou notre tableau de bord sous Paramètres avancés dans le compositeur de push comme illustré :

Priorité d’affichage de la notification

Le niveau de priorité d’une notification push affecte la manière dont votre notification est affichée dans la barre de notification par rapport à d’autres notifications. Il peut également affecter la vitesse et la manière de livrer, car les messages normaux et moins prioritaires peuvent être envoyés avec une latence légèrement plus élevée ou groupés pour préserver la durée de vie de la batterie, alors que les messages haute priorité sont toujours envoyés immédiatement.

Dans Android O, la priorité de notification est devenue une propriété des canaux de notification. Vous devrez travailler avec votre développeur pour définir la priorité d’un canal pendant sa configuration, puis utiliser le tableau de bord pour sélectionner le canal approprié lors de l’envoi de vos sons de notification. Pour les appareils fonctionnant sous des versions d’Android antérieures à O, il est possible de définir un niveau de priorité pour les notifications Android via le tableau de bord de Braze et l’API d’envoi de messages.

Pour envoyer un message à l’ensemble de votre base d’utilisateurs avec une priorité spécifique, nous vous recommandons de spécifier indirectement la priorité via la configuration du canal de notification (pour cibler les appareils O+) et d’envoyer la priorité individuelle à partir du tableau de bord (pour cibler les appareils <O).

Les niveaux de priorité que vous pouvez définir sur les notifications push Android ou Fire OS sont les suivants :

Pour plus d’informations, veuillez consulter la documentation de Google sur les notifications Android.

Sons

Dans Android O, les sons de notification sont devenus une propriété des canaux de notification. Vous devrez travailler avec votre développeur pour définir le son d’un canal pendant sa configuration, puis utiliser le tableau de bord pour sélectionner le canal approprié lors de l’envoi de vos notifications.

Pour les appareils fonctionnant dans des versions d’Android antérieures à O, Braze vous permet de définir le son d’un message de notification push individuel via le composeur du tableau de bord. Vous pouvez le faire en spécifiant une ressource sonore locale sur l’appareil (par exemple, android.resource://com.mycompany.myapp/raw/mysound). Spécifier « par défaut » dans ce champ jouera le son de notification par défaut sur l’appareil. Cela peut être spécifié via l’API Messages ou le tableau de bord sous Paramètres avancés dans le compositeur de push.

Saisissez l’URI complet de la ressource sonore (par exemple, android.resource://com.mycompany.myapp/raw/mysound) dans l’invite du tableau de bord.

Pour envoyer un message à l’ensemble de votre base d’utilisateurs avec un son spécifique, nous vous recommandons de spécifier indirectement le son via la configuration du canal de notification (pour cibler les appareils O+) et d’envoyer le son individuel depuis le tableau de bord (pour cibler les appareils <O).