in-app Messages
Découvrez les messages in-app et comment les configurer pour le SDK de Braze.
Conditions préalables
Avant de pouvoir utiliser cette fonctionnalité, vous devrez intégrer le SDK Android Braze. You’ll also need to enable in-app messages.
Message types
Braze offers several default in-app message types, each customizable with messages, images, Font Awesome icons, click actions, analytics, color schemes, and more.
Their basic behavior and traits are defined by the IInAppMessage
interface, in a subclass called InAppMessageBase
. IInAppMessage
also includes a subinterface, IInAppMessageImmersive
, which lets you add close, click-action, and analytics buttons to your app.
Keep in mind, in-app messages containing buttons will include the clickAction
message in the final payload if the click action is added prior to adding the button text.
modal
in-app messages appear in the center of the screen and are framed by a translucent panel. Useful for more critical messaging, they can be equipped with two click-action and analytics-enabled buttons.
This message type is a subclass of InAppMessageImmersiveBase
, an abstract class that implements IInAppMessageImmersive
, giving you the option to add custom functionality to your locally generated in-app messages.
full
in-app messages are useful for maximizing the content and impact of your user communication. The upper half of a full
in-app message contains an image, and the lower half displays text and up to two click action and analytics-enabled buttons.
This message type extends InAppMessageImmersiveBase
, giving you the option to add custom functionality to your locally generated in-app messages.
HTML
in-app messages are useful for creating fully customized user content. User-defined HTML in-app message content is displayed in a WebView
and may optionally contain other rich content, such as images and fonts, allowing for full control over message appearance and functionality.
This message type implements IInAppMessageHtml
, which is a subclass of IInAppMessage
.
Android in-app messages support a JavaScript brazeBridge
interface to call methods on the Braze Android SDK from within your HTML, see our JavaScript bridge page for more details.
We currently do not support the display of custom HTML in-app messages in an iFrame on the iOS and Android platforms.
You can also define custom in-app message views for your app. For a full walkthrough, see Setting custom factories.
Enabling in-app messages
Step 1: Register BrazeInAppMessageManager
In-app message display is managed by the BrazeInAppMessageManager
class. Every activity in your app must be registered with the BrazeInAppMessageManager
to allow it to add in-app message views to the view hierarchy. There are two ways to accomplish this:
The activity lifecycle callback integration handles in-app message registration automatically; no extra integration is required. This is the recommended method for handling in-app message registration.
If you’re using activity lifecycle callback for automatic registration, do not complete this step.
In your Application.onCreate()
, call ensureSubscribedToInAppMessageEvents()
:
1
BrazeInAppMessageManager.getInstance().ensureSubscribedToInAppMessageEvents(context);
1
BrazeInAppMessageManager.getInstance().ensureSubscribedToInAppMessageEvents(context)
In every activity where in-app messages can be shown, call registerInAppMessageManager()
in that activity’s onResume()
:
1
2
3
4
5
6
7
@Override
public void onResume() {
super.onResume();
// Registers the BrazeInAppMessageManager for the current Activity. This Activity will now listen for
// in-app messages from Braze.
BrazeInAppMessageManager.getInstance().registerInAppMessageManager(activity);
}
1
2
3
4
5
6
public override fun onResume() {
super.onResume()
// Registers the BrazeInAppMessageManager for the current Activity. This Activity will now listen for
// in-app messages from Braze.
BrazeInAppMessageManager.getInstance().registerInAppMessageManager(this)
}
In every activity where registerInAppMessageManager()
was called, call unregisterInAppMessageManager()
in that activity’s onPause()
:
1
2
3
4
5
6
@Override
public void onPause() {
super.onPause();
// Unregisters the BrazeInAppMessageManager for the current Activity.
BrazeInAppMessageManager.getInstance().unregisterInAppMessageManager(activity);
}
1
2
3
4
5
public override fun onPause() {
super.onPause()
// Unregisters the BrazeInAppMessageManager.
BrazeInAppMessageManager.getInstance().unregisterInAppMessageManager(this)
}
Step 2: Update the manager’s blocklist (optional)
In your integration, you may require that certain activities in your app should not show in-app messages. The activity lifecycle callback integration provides an easy way to accomplish this.
The following sample code adds two activities to the in-app message registration blocklist, SplashActivity
and SettingsActivity
:
1
2
3
4
5
6
7
8
9
10
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
Set<Class> inAppMessageBlocklist = new HashSet<>();
inAppMessageBlocklist.add(SplashActivity.class);
inAppMessageBlocklist.add(SettingsActivity.class);
registerActivityLifecycleCallbacks(new BrazeActivityLifecycleCallbackListener(inAppMessageBlocklist));
}
}
1
2
3
4
5
6
7
8
9
class MyApplication : Application() {
override fun onCreate() {
super.onCreate()
val inAppMessageBlocklist = HashSet<Class<*>>()
inAppMessageBlocklist.add(SplashActivity::class.java)
inAppMessageBlocklist.add(SettingsActivity::class.java)
registerActivityLifecycleCallbacks(BrazeActivityLifecycleCallbackListener(inAppMessageBlocklist))
}
}
Conditions préalables
Avant de pouvoir utiliser cette fonctionnalité, vous devrez intégrer le SDK Swift Braze. Vous devrez également activer les messages in-app.
Types de messages
Chaque type de message in-app est hautement personnalisable en termes de contenu, d’images, d’icônes, d’actions de clic, d’analyse, d’affichage et de diffusion. Il s’agit de types énumérés de Braze.InAppMessage
, qui définit le comportement et les caractéristiques de base de tous les messages in-app. Pour obtenir la liste complète des propriétés et de l’utilisation des messages in-app, consultez la classeInAppMessage
.
Voici les types de messages in-app disponibles dans Braze et ce à quoi ils ressembleront pour les utilisateurs finaux.
Les messages in-app de type Modal
apparaissent au centre de l’écran et sont encadrés par un panneau transparent. Utiles pour les communications plus critiques, ils peuvent être équipés d’un maximum de deux boutons dotés d’une fonction d’analyse.
Les messages in-app de type Modal Image
apparaissent au centre de l’écran et sont encadrés par un panneau transparent. Ces messages sont similaires au type Modal
, mais sans en-tête ni texte de message. Utiles pour les communications plus critiques, ils peuvent être équipés d’un maximum de deux boutons dotés d’une fonction d’analyse.
Full
Les messages in-app sont utiles pour maximiser le contenu et l’impact de votre communication avec les utilisateurs. La moitié supérieure d’un message in-app Full
contient une image, et la moitié inférieure affiche du texte et jusqu’à deux boutons permettant l’analyse.
Les messages in-app Full Image
sont similaires aux messages in-app Full
, sauf qu’ils ne comportent pas d’en-tête ni de texte de message. Ce type de message est utile pour maximiser le contenu et l’impact de votre communication avec les utilisateurs. Un message in-app Full Image
contient une image qui s’étend sur tout l’écran, avec la possibilité d’afficher jusqu’à deux boutons compatibles avec l’analyse.
Les messages in-app HTML
sont utiles pour créer un contenu utilisateur entièrement personnalisé. Le contenu des messages in-app entièrement en HTML défini par l’utilisateur est affiché dans un WKWebView
et peut éventuellement contenir d’autres contenus enrichis, tels que des images et des polices, permettant un contrôle total de l’apparence et de la fonctionnalité du message.
Les messages in-app IOS prennent en charge une interface JavaScript brazeBridge
pour appeler des méthodes sur le SDK Braze pour le Web depuis votre HTML. Pour plus d’informations, consultez nos meilleures pratiques.
L’exemple suivant montre la mise en page d’un message in-app HTML complet :
Notez que nous ne prenons actuellement pas en charge l’affichage de messages in-app HTML personnalisés dans un iFrame sur les plateformes iOS et Android.
Les messages in-app Control
ne contiennent pas de composant d’interface utilisateur et sont utilisés principalement à des fins d’analyse. Ce type est utilisé pour vérifier la réception d’un message in-app envoyé à un groupe de contrôle.
Pour plus de détails sur la sélection intelligente et les groupes de contrôle, reportez-vous à la section Sélection intelligente.
Activation des messages in-app
Étape 1 : Créez une implémentation de BrazeInAppMessagePresenter
Pour permettre à Braze d’afficher des messages in-app, créez une implémentation du protocole BrazeInAppMessagePresenter
et attribuez-la à l’option inAppMessagePresenter
de votre instance Braze. Vous pouvez également utiliser le présentateur par défaut de Braze UI en instanciant un objet BrazeInAppMessageUI
.
Notez que vous devrez importer la bibliothèque BrazeUI
pour accéder à la classe BrazeInAppMessageUI
.
1
AppDelegate.braze?.inAppMessagePresenter = BrazeInAppMessageUI()
1
AppDelegate.braze.inAppMessagePresenter = [[BrazeInAppMessageUI alloc] init];
Étape 2 : Manipuler aucun déclencheur correspondant
Mettre en œuvre BrazeDelegate.(_:noMatchingTriggerForEvent)
dans la classe BrazeDelegate
concernée. Lorsque Braze ne parvient pas à trouver un déclencheur correspondant à un événement particulier, il appelle automatiquement cette méthode.
Prerequisites
Before you can use this feature, you’ll need to integrate the Web Braze SDK. Cependant, aucune configuration supplémentaire n’est nécessaire.
Types de messages
Tous les messages in-app héritent de leur prototype de InAppMessage
qui définit le comportement de base et les caractéristiques de tous les messages in-app. Les sous-classes prototypiques sont SlideUpMessage
, ModalMessage
, FullScreenMessage
, et HtmlMessage
.
Chaque type de message in-app est personnalisable sur le contenu, les images, les icônes, les boutons d’action, l’analyse, l’affichage et la livraison.
SlideUp
Les messages in-app sont ainsi nommés parce que traditionnellement, sur les plateformes mobiles, ils “glissent vers le haut” ou “glissent vers le bas” depuis le haut ou le bas de l’écran. Dans le SDK Braze de Web, ces messages sont affichés comme une notification de style Growl ou Toast pour s’aligner sur le paradigme dominant du Web. Ils recouvrent une petite partie de l’écran et offrent une fonctionnalité de messagerie efficace et non intrusive.
Les messages in-app de type Modal
apparaissent au centre de l’écran et sont encadrés par un panneau transparent. Utiles pour les messages plus critiques, ils peuvent être pourvus de deux actions à clic et de boutons d’analyse.
Full
Les messages in-app sont utiles pour maximiser le contenu et l’impact de votre communication avec les utilisateurs. Dans les fenêtres de navigateur étroites (par exemple, le Web mobile), les messages in-app full
occupent toute la fenêtre du navigateur. Sur les fenêtres de navigateur plus grandes, les messages in-app full
apparaissent de la même manière que les messages in-app modal
. La moitié supérieure d’un message in-app full
contient une image, et la moitié inférieure autorise jusqu’à huit lignes de texte ainsi que jusqu’à deux boutons d’action permettant l’analyse
Les messages in-app HTML
sont utiles pour créer un contenu utilisateur entièrement personnalisé. Le HTML défini par l’utilisateur est affiché dans un iframe et peut contenir du contenu enrichi, comme des images, des polices, des vidéos et des éléments interactifs, permettant un contrôle total de l’apparence et de la fonctionnalité du message. Ceux-ci prennent en charge une interface JavaScript brazeBridge
pour appeler des méthodes du Braze Web SDK à partir de votre HTML, voir nos meilleures pratiques pour plus de détails.
Pour activer les messages in-app HTML via le SDK Web, vous devez fournir l’option d’initialisation allowUserSuppliedJavascript
à Braze, par exemple, braze.initialize('YOUR-API_KEY', {allowUserSuppliedJavascript: true})
. Pour des raisons de sécurité, les messages in-app HTML peuvent en effet exécuter JavaScript, d’où le besoin d’un responsable de site pour les activer.
L’exemple suivant montre un message in-app HTML paginé :
Conditions préalables
Avant de pouvoir utiliser cette fonctionnalité, vous devrez intégrer le SDK Android Braze.
About TV and OTT support
The Android Braze SDK natively supports displaying in-app messages on OTT devices like Android TV or Fire Stick. However, there’s some key differences between native Android and OTT in-app messages. For OTT devices:
- In-app messages that require touch mode, such as slideup, are disabled on OTT.
- The currently selected or focused item, such as a button or close button, will be highlighted.
- Body clicks on the in-app message itself, such as not on a button, are not supported.
Prerequisites
Before you can use this feature, you’ll need to integrate the Cordova Braze SDK.
Message types
Braze offers several default in-app message types, each customizable with messages, images, Font Awesome icons, click actions, analytics, color schemes, and more.
Their basic behavior and traits are defined by the IInAppMessage
interface, in a subclass called InAppMessageBase
. IInAppMessage
also includes a subinterface, IInAppMessageImmersive
, which lets you add close, click-action, and analytics buttons to your app.
Keep in mind, in-app messages containing buttons will include the clickAction
message in the final payload if the click action is added prior to adding the button text.
modal
in-app messages appear in the center of the screen and are framed by a translucent panel. Useful for more critical messaging, they can be equipped with two click-action and analytics-enabled buttons.
This message type is a subclass of InAppMessageImmersiveBase
, an abstract class that implements IInAppMessageImmersive
, giving you the option to add custom functionality to your locally generated in-app messages.
full
in-app messages are useful for maximizing the content and impact of your user communication. The upper half of a full
in-app message contains an image, and the lower half displays text and up to two click action and analytics-enabled buttons.
This message type extends InAppMessageImmersiveBase
, giving you the option to add custom functionality to your locally generated in-app messages.
HTML
in-app messages are useful for creating fully customized user content. User-defined HTML in-app message content is displayed in a WebView
and may optionally contain other rich content, such as images and fonts, allowing for full control over message appearance and functionality.
This message type implements IInAppMessageHtml
, which is a subclass of IInAppMessage
.
Android in-app messages support a JavaScript brazeBridge
interface to call methods on the Braze Android SDK from within your HTML, see our JavaScript bridge page for more details.
We currently do not support the display of custom HTML in-app messages in an iFrame on the iOS and Android platforms.
You can also define custom in-app message views for your app. For a full walkthrough, see Setting custom factories.
Each in-app message type is highly customizable across content, images, icons, click actions, analytics, display, and delivery. They are enumerated types of Braze.InAppMessage
, which defines basic behavior and traits for all in-app messages. For the full list of in-app message properties and usage, see the InAppMessage
class.
These are the available in-app message types in Braze and how they will look like for end-users.
Modal
in-app messages appear in the center of the screen and are framed by a translucent panel. Useful for more critical messaging, they can be equipped with up to two analytics-enabled buttons.
Modal Image
in-app messages appear in the center of the screen and are framed by a translucent panel. These messages are similar to the Modal
type except without header or message text. Useful for more critical messaging, they can be equipped with up to two analytics-enabled buttons.
Full
in-app messages are useful for maximizing the content and impact of your user communication. The upper half of a Full
in-app message contains an image, and the lower half displays text and up to two analytics-enabled buttons.
Full Image
in-app messages are similar to Full
in-app messages except without header or message text. This message type is useful for maximizing the content and impact of your user communication. A Full Image
in-app message contains an image spanning the entire screen, with the option to display up to two analytics-enabled buttons.
HTML
in-app messages are useful for creating fully customized user content. User-defined HTML Full in-app message content is displayed in a WKWebView
and may optionally contain other rich content, such as images and fonts, allowing for full control over message appearance and functionality.
iOS in-app messages support a JavaScript brazeBridge
interface to call methods on the Braze Web SDK from within your HTML, see our best practices for more details.
The following example shows a paginated HTML Full in-app message:
Note that we currently do not support the display of custom HTML in-app messages in an iFrame on the iOS and Android platforms.
Control
in-app messages do not contain a UI component and are used primarily for analytics purposes. This type is used to verify receipt of an in-app message sent to a control group.
For further details about Intelligent Selection and control groups, refer to Intelligent Selection.
Conditions préalables
Avant de pouvoir utiliser cette fonctionnalité, vous devrez intégrer le SDK de Flutter Braze.
Types de messages
Braze propose plusieurs types de messages in-app par défaut, chacun personnalisable avec des messages, des images, des icônes Font Awesome, des actions de clic, des analyses, des schémas de couleurs, et plus encore.
Leur comportement de base et leurs caractéristiques sont définis par l’interface IInAppMessage
dans une sous-classe appelée InAppMessageBase
. IInAppMessage
comprend également une sous-interface, IInAppMessageImmersive
qui vous permet d’ajouter des boutons de fermeture, de clic-action et d’analyse/analytique à votre application.
N’oubliez pas que les messages in-app contenant des boutons incluront le message clickAction
dans la charge utile finale si l’action de clic est ajoutée avant l’ajout du texte du bouton.
Les messages in-app de type modal
apparaissent au centre de l’écran et sont encadrés par un panneau transparent. Ils sont utiles pour les messages plus critiques et peuvent être équipés d’un bouton d’action et d’un bouton activé par analyse.
Ce type de message est une sous-classe de InAppMessageImmersiveBase
une classe abstraite qui implémente IInAppMessageImmersive
, ce qui vous permet d’ajouter des fonctionnalités personnalisées à vos messages in-app générés localement.
full
Les messages in-app sont utiles pour maximiser le contenu et l’impact de votre communication avec les utilisateurs. La moitié supérieure d’un full
message in-app contient une image, et la moitié inférieure affiche le texte et deux boutons d’action permettant l’analyse.
Ce type de message s’étend à InAppMessageImmersiveBase
vous permettant d’ajouter des fonctionnalités personnalisées à vos messages in-app générés localement.
Les messages in-app HTML
sont utiles pour créer un contenu utilisateur entièrement personnalisé. Le contenu du message in-app en HTML défini par l’utilisateur est affiché dans un WebView
et peut éventuellement contenir d’autres contenus enrichis, tels que des images et des polices, permettant un contrôle total de l’apparence et de la fonctionnalité du message.
Ces messages sont des instances de InAppMessageHtml
qui mettent en œuvre la sous-classe IInAppMessage
: IInAppMessageHtml
.
Les messages in-app Android prennent en charge une interface JavaScript brazeBridge
pour appeler des méthodes SDK Braze pour le Web depuis votre HTML. Consultez nos meilleures pratiques pour plus de détails.
Actuellement, nous ne prenons pas en charge l’affichage de messages in-app HTML personnalisés dans un iFrame sur les plateformes iOS et Android.
Vous pouvez également définir des envois de messages in-app personnalisés pour votre application. Pour en savoir plus, consultez la rubrique Création d’usines personnalisées.
Chaque type de message in-app est hautement personnalisable en termes de contenu, d’images, d’icônes, d’actions de clic, d’analyse, d’affichage et de diffusion. Il s’agit de types énumérés de Braze.InAppMessage
, qui définit le comportement et les caractéristiques de base de tous les messages in-app. Pour obtenir la liste complète des propriétés et de l’utilisation des messages in-app, consultez la classeInAppMessage
.
Voici les types de messages in-app disponibles dans Braze et ce à quoi ils ressembleront pour les utilisateurs finaux.
Les messages in-app de type Modal
apparaissent au centre de l’écran et sont encadrés par un panneau transparent. Utiles pour les communications plus critiques, ils peuvent être équipés d’un maximum de deux boutons dotés d’une fonction d’analyse.
Les messages in-app de type Modal Image
apparaissent au centre de l’écran et sont encadrés par un panneau transparent. Ces messages sont similaires au type Modal
, mais sans en-tête ni texte de message. Utiles pour les communications plus critiques, ils peuvent être équipés d’un maximum de deux boutons dotés d’une fonction d’analyse.
Full
Les messages in-app sont utiles pour maximiser le contenu et l’impact de votre communication avec les utilisateurs. La moitié supérieure d’un message in-app Full
contient une image, et la moitié inférieure affiche du texte et jusqu’à deux boutons permettant l’analyse.
Les messages in-app Full Image
sont similaires aux messages in-app Full
, sauf qu’ils ne comportent pas d’en-tête ni de texte de message. Ce type de message est utile pour maximiser le contenu et l’impact de votre communication avec les utilisateurs. Un message in-app Full Image
contient une image qui s’étend sur tout l’écran, avec la possibilité d’afficher jusqu’à deux boutons compatibles avec l’analyse.
Les messages in-app HTML
sont utiles pour créer un contenu utilisateur entièrement personnalisé. Le contenu des messages in-app entièrement en HTML défini par l’utilisateur est affiché dans un WKWebView
et peut éventuellement contenir d’autres contenus enrichis, tels que des images et des polices, permettant un contrôle total de l’apparence et de la fonctionnalité du message.
Les messages in-app IOS prennent en charge une interface JavaScript brazeBridge
pour appeler des méthodes sur le SDK Braze pour le Web depuis votre HTML. Pour plus d’informations, consultez nos meilleures pratiques.
L’exemple suivant montre la mise en page d’un message in-app HTML complet :
Notez que nous ne prenons actuellement pas en charge l’affichage de messages in-app HTML personnalisés dans un iFrame sur les plateformes iOS et Android.
Les messages in-app Control
ne contiennent pas de composant d’interface utilisateur et sont utilisés principalement à des fins d’analyse. Ce type est utilisé pour vérifier la réception d’un message in-app envoyé à un groupe de contrôle.
Pour plus de détails sur la sélection intelligente et les groupes de contrôle, reportez-vous à la section Sélection intelligente.
Prerequisites
Before you can use this feature, you’ll need to integrate the React Native Braze SDK.
Types de messages
Braze propose plusieurs types de messages in-app par défaut, chacun personnalisable avec des messages, des images, des icônes Font Awesome, des actions de clic, des analyses, des schémas de couleurs, et plus encore.
Leur comportement de base et leurs caractéristiques sont définis par l’interface IInAppMessage
dans une sous-classe appelée InAppMessageBase
. IInAppMessage
comprend également une sous-interface, IInAppMessageImmersive
qui vous permet d’ajouter des boutons de fermeture, de clic-action et d’analyse/analytique à votre application.
N’oubliez pas que les messages in-app contenant des boutons incluront le message clickAction
dans la charge utile finale si l’action de clic est ajoutée avant l’ajout du texte du bouton.
Les messages in-app de type modal
apparaissent au centre de l’écran et sont encadrés par un panneau transparent. Ils sont utiles pour les messages plus critiques et peuvent être équipés d’un bouton d’action et d’un bouton activé par analyse.
Ce type de message est une sous-classe de InAppMessageImmersiveBase
une classe abstraite qui implémente IInAppMessageImmersive
, ce qui vous permet d’ajouter des fonctionnalités personnalisées à vos messages in-app générés localement.
full
Les messages in-app sont utiles pour maximiser le contenu et l’impact de votre communication avec les utilisateurs. La moitié supérieure d’un full
message in-app contient une image, et la moitié inférieure affiche le texte et deux boutons d’action permettant l’analyse.
Ce type de message s’étend à InAppMessageImmersiveBase
vous permettant d’ajouter des fonctionnalités personnalisées à vos messages in-app générés localement.
Les messages in-app HTML
sont utiles pour créer un contenu utilisateur entièrement personnalisé. Le contenu du message in-app en HTML défini par l’utilisateur est affiché dans un WebView
et peut éventuellement contenir d’autres contenus enrichis, tels que des images et des polices, permettant un contrôle total de l’apparence et de la fonctionnalité du message.
Ces messages sont des instances de InAppMessageHtml
qui mettent en œuvre la sous-classe IInAppMessage
: IInAppMessageHtml
.
Les messages in-app Android prennent en charge une interface JavaScript brazeBridge
pour appeler des méthodes SDK Braze pour le Web depuis votre HTML. Consultez nos meilleures pratiques pour plus de détails.
Actuellement, nous ne prenons pas en charge l’affichage de messages in-app HTML personnalisés dans un iFrame sur les plateformes iOS et Android.
Vous pouvez également définir des envois de messages in-app personnalisés pour votre application. Pour en savoir plus, consultez la rubrique Création d’usines personnalisées.
Chaque type de message in-app est hautement personnalisable en termes de contenu, d’images, d’icônes, d’actions de clic, d’analyse, d’affichage et de diffusion. Il s’agit de types énumérés de Braze.InAppMessage
, qui définit le comportement et les caractéristiques de base de tous les messages in-app. Pour obtenir la liste complète des propriétés et de l’utilisation des messages in-app, consultez la classeInAppMessage
.
Voici les types de messages in-app disponibles dans Braze et ce à quoi ils ressembleront pour les utilisateurs finaux.
Les messages in-app de type Modal
apparaissent au centre de l’écran et sont encadrés par un panneau transparent. Utiles pour les communications plus critiques, ils peuvent être équipés d’un maximum de deux boutons dotés d’une fonction d’analyse.
Les messages in-app de type Modal Image
apparaissent au centre de l’écran et sont encadrés par un panneau transparent. Ces messages sont similaires au type Modal
, mais sans en-tête ni texte de message. Utiles pour les communications plus critiques, ils peuvent être équipés d’un maximum de deux boutons dotés d’une fonction d’analyse.
Full
Les messages in-app sont utiles pour maximiser le contenu et l’impact de votre communication avec les utilisateurs. La moitié supérieure d’un message in-app Full
contient une image, et la moitié inférieure affiche du texte et jusqu’à deux boutons permettant l’analyse.
Les messages in-app Full Image
sont similaires aux messages in-app Full
, sauf qu’ils ne comportent pas d’en-tête ni de texte de message. Ce type de message est utile pour maximiser le contenu et l’impact de votre communication avec les utilisateurs. Un message in-app Full Image
contient une image qui s’étend sur tout l’écran, avec la possibilité d’afficher jusqu’à deux boutons compatibles avec l’analyse.
Les messages in-app HTML
sont utiles pour créer un contenu utilisateur entièrement personnalisé. Le contenu des messages in-app entièrement en HTML défini par l’utilisateur est affiché dans un WKWebView
et peut éventuellement contenir d’autres contenus enrichis, tels que des images et des polices, permettant un contrôle total de l’apparence et de la fonctionnalité du message.
Les messages in-app IOS prennent en charge une interface JavaScript brazeBridge
pour appeler des méthodes sur le SDK Braze pour le Web depuis votre HTML. Pour plus d’informations, consultez nos meilleures pratiques.
L’exemple suivant montre la mise en page d’un message in-app HTML complet :
Notez que nous ne prenons actuellement pas en charge l’affichage de messages in-app HTML personnalisés dans un iFrame sur les plateformes iOS et Android.
Les messages in-app Control
ne contiennent pas de composant d’interface utilisateur et sont utilisés principalement à des fins d’analyse. Ce type est utilisé pour vérifier la réception d’un message in-app envoyé à un groupe de contrôle.
Pour plus de détails sur la sélection intelligente et les groupes de contrôle, reportez-vous à la section Sélection intelligente.
Modèle de données
Le modèle de message in-app est disponible dans le SDK React Native. Braze propose quatre types de messages in-app qui partagent le même modèle de données : contextuel fenêtre modale, complet et HTML complet.
Messages
Le modèle de message in-app constitue la base de tous les messages in-app.
Propriété | Description |
---|---|
inAppMessageJsonString |
La représentation JSON du message. |
message |
Le texte du message. |
header |
L’en-tête du message. |
uri |
L’URI associé à l’action de clic sur le bouton. |
imageUrl |
L’URL de l’image du message. |
zippedAssetsUrl |
Les ressources zippées préparées pour afficher le contenu HTML. |
useWebView |
Indique si l’action de clic sur le bouton doit être redirigée à l’aide d’une vue web. |
duration |
La durée d’affichage du message. |
clickAction |
Le type d’action « clic sur bouton ». Les trois types sont les suivants : NEWS_FEED , URI , et NONE . |
dismissType |
Le type de fermeture du message. Les deux types sont : SWIPE et AUTO_DISMISS . |
messageType |
Le type de message in-app pris en charge par le SDK. Les quatre types sont les suivants : SLIDEUP , MODAL , FULL et HTML_FULL . |
extras |
Le dictionnaire des suppléments de message. Valeur par défaut : [:] . |
buttons |
La liste des boutons sur le message in-app. |
toString() |
L’envoi de messages sous la forme d’une chaîne de caractères. |
Pour une référence complète du modèle d’envoi de messages in-app, consultez la documentation Android et iOS.
Boutons
Des boutons peuvent être ajoutés aux messages in-app pour effectuer des actions et enregistrer des analyses. Le modèle de bouton constitue la base de tous les boutons de messages in-app.
Propriété | Description |
---|---|
text |
Le texte du bouton. |
uri |
L’URI associé à l’action de clic sur le bouton. |
useWebView |
Indique si l’action de clic sur le bouton doit être redirigée à l’aide d’une vue web. |
clickAction |
Le type d’action de clic traité lorsque l’utilisateur clique sur le bouton. Les trois types sont les suivants : NEWS_FEED , URI , et NONE . |
id |
L’ID du bouton dans le message. |
toString() |
Le bouton sous forme de chaîne de caractères. |
Pour une référence complète du modèle de bouton, consultez la documentation Android et iOS.
Prerequisites
Before you can use this feature, you’ll need to integrate the Roku Braze SDK. En outre, les messages in-app ne seront envoyés qu’aux appareils Roku fonctionnant avec la version minimale du SDK prise en charge :
Types de messages
Braze propose plusieurs types de messages in-app par défaut, chacun personnalisable avec des messages, des images, des icônes Font Awesome, des actions de clic, des analyses, des schémas de couleurs, et plus encore.
Leur comportement de base et leurs caractéristiques sont définis par l’interface IInAppMessage
dans une sous-classe appelée InAppMessageBase
. IInAppMessage
comprend également une sous-interface, IInAppMessageImmersive
qui vous permet d’ajouter des boutons de fermeture, de clic-action et d’analyse/analytique à votre application.
N’oubliez pas que les messages in-app contenant des boutons incluront le message clickAction
dans la charge utile finale si l’action de clic est ajoutée avant l’ajout du texte du bouton.
Les messages in-app de type modal
apparaissent au centre de l’écran et sont encadrés par un panneau transparent. Ils sont utiles pour les messages plus critiques et peuvent être équipés d’un bouton d’action et d’un bouton activé par analyse.
Ce type de message est une sous-classe de InAppMessageImmersiveBase
une classe abstraite qui implémente IInAppMessageImmersive
, ce qui vous permet d’ajouter des fonctionnalités personnalisées à vos messages in-app générés localement.
full
Les messages in-app sont utiles pour maximiser le contenu et l’impact de votre communication avec les utilisateurs. La moitié supérieure d’un full
message in-app contient une image, et la moitié inférieure affiche le texte et deux boutons d’action permettant l’analyse.
Ce type de message s’étend à InAppMessageImmersiveBase
vous permettant d’ajouter des fonctionnalités personnalisées à vos messages in-app générés localement.
Les messages in-app HTML
sont utiles pour créer un contenu utilisateur entièrement personnalisé. Le contenu du message in-app en HTML défini par l’utilisateur est affiché dans un WebView
et peut éventuellement contenir d’autres contenus enrichis, tels que des images et des polices, permettant un contrôle total de l’apparence et de la fonctionnalité du message.
Ces messages sont des instances de InAppMessageHtml
qui mettent en œuvre la sous-classe IInAppMessage
: IInAppMessageHtml
.
Les messages in-app Android prennent en charge une interface JavaScript brazeBridge
pour appeler des méthodes SDK Braze pour le Web depuis votre HTML. Consultez nos meilleures pratiques pour plus de détails.
Actuellement, nous ne prenons pas en charge l’affichage de messages in-app HTML personnalisés dans un iFrame sur les plateformes iOS et Android.
Vous pouvez également définir des envois de messages in-app personnalisés pour votre application. Pour en savoir plus, consultez la rubrique Création d’usines personnalisées.
Chaque type de message in-app est hautement personnalisable en termes de contenu, d’images, d’icônes, d’actions de clic, d’analyse, d’affichage et de diffusion. Il s’agit de types énumérés de Braze.InAppMessage
, qui définit le comportement et les caractéristiques de base de tous les messages in-app. Pour obtenir la liste complète des propriétés et de l’utilisation des messages in-app, consultez la classeInAppMessage
.
Voici les types de messages in-app disponibles dans Braze et ce à quoi ils ressembleront pour les utilisateurs finaux.
Les messages in-app de type Modal
apparaissent au centre de l’écran et sont encadrés par un panneau transparent. Utiles pour les communications plus critiques, ils peuvent être équipés d’un maximum de deux boutons dotés d’une fonction d’analyse.
Les messages in-app de type Modal Image
apparaissent au centre de l’écran et sont encadrés par un panneau transparent. Ces messages sont similaires au type Modal
, mais sans en-tête ni texte de message. Utiles pour les communications plus critiques, ils peuvent être équipés d’un maximum de deux boutons dotés d’une fonction d’analyse.
Full
Les messages in-app sont utiles pour maximiser le contenu et l’impact de votre communication avec les utilisateurs. La moitié supérieure d’un message in-app Full
contient une image, et la moitié inférieure affiche du texte et jusqu’à deux boutons permettant l’analyse.
Les messages in-app Full Image
sont similaires aux messages in-app Full
, sauf qu’ils ne comportent pas d’en-tête ni de texte de message. Ce type de message est utile pour maximiser le contenu et l’impact de votre communication avec les utilisateurs. Un message in-app Full Image
contient une image qui s’étend sur tout l’écran, avec la possibilité d’afficher jusqu’à deux boutons compatibles avec l’analyse.
Les messages in-app HTML
sont utiles pour créer un contenu utilisateur entièrement personnalisé. Le contenu des messages in-app entièrement en HTML défini par l’utilisateur est affiché dans un WKWebView
et peut éventuellement contenir d’autres contenus enrichis, tels que des images et des polices, permettant un contrôle total de l’apparence et de la fonctionnalité du message.
Les messages in-app IOS prennent en charge une interface JavaScript brazeBridge
pour appeler des méthodes sur le SDK Braze pour le Web depuis votre HTML. Pour plus d’informations, consultez nos meilleures pratiques.
L’exemple suivant montre la mise en page d’un message in-app HTML complet :
Notez que nous ne prenons actuellement pas en charge l’affichage de messages in-app HTML personnalisés dans un iFrame sur les plateformes iOS et Android.
Les messages in-app Control
ne contiennent pas de composant d’interface utilisateur et sont utilisés principalement à des fins d’analyse. Ce type est utilisé pour vérifier la réception d’un message in-app envoyé à un groupe de contrôle.
Pour plus de détails sur la sélection intelligente et les groupes de contrôle, reportez-vous à la section Sélection intelligente.
Activation des messages in-app
Étape 1 : Ajouter un observateur
Pour traiter les messages in-app, vous pouvez ajouter un observateur à BrazeTask.BrazeInAppMessage
:
1
m.BrazeTask.observeField("BrazeInAppMessage", "onInAppMessageReceived")
Étape 2 : Accéder aux messages déclenchés
Puis, dans votre gestionnaire, vous avez accès au message in-app le plus élevé que vos campagnes ont déclenché :
1
2
3
4
sub onInAppMessageReceived()
in_app_message = m.BrazeTask.BrazeInAppMessage
...
end sub
Champs de messages
Manipulation
Les champs suivants répertorient les champs dont vous aurez besoin pour gérer vos messages in-app :
Champs | Description |
---|---|
buttons |
Liste des boutons (peut être une liste vide). |
click_action |
"URI" ou "NONE" . Utilisez ce champ pour indiquer si le message in-app doit s’ouvrir sur un lien URI ou fermer le message lorsque vous cliquez dessus. Lorsqu’il n’y a pas de boutons, cela doit se produire lorsque l’utilisateur clique sur « OK » quand le message in-app s’affiche. |
dismiss_type |
"AUTO_DISMISS" ou "SWIPE" . Utilisez ce champ pour indiquer si votre message intégré à l’application sera automatiquement supprimé ou nécessitera d’être balayé pour être supprimé. |
display_delay |
Durée d’attente (en secondes) jusqu’à l’affichage du message in-app. |
duration |
Durée d’affichage (en millisecondes) du message quand dismiss_type est défini sur "AUTO_DISMISS" . |
extras |
Paires clé-valeur. |
header |
Le texte de l’en-tête. |
id |
L’ID utilisé pour journaliser les impressions ou les clics. |
image_url |
URL de l’image du message in-app. |
message |
Texte du corps de message. |
uri |
Vos utilisateurs URI seront envoyés vers en fonction de votre click_action . Ce champ doit être inclus lorsque click_action est "URI" . |
Pour les messages in-app contenant des boutons, le message click_action
sera également inclus dans la charge utile finale si l’action de clic est ajoutée avant l’ajout du texte du bouton.
Stylisme
Il existe également plusieurs champs de style que vous pouvez choisir d’utiliser dans le tableau de bord :
Champs | Description |
---|---|
bg_color |
Couleur d’arrière-plan. |
close_button_color |
Couleur du bouton de fermeture. |
frame_color |
La couleur du recouvrement de l’écran d’arrière-plan. |
header_text_color |
Couleur du texte en-tête. |
message_text_color |
Couleur du texte du message. |
text_align |
« START », « CENTER » ou « END ». L’alignement de texte que vous avez sélectionné. |
Vous pouvez également implémenter le message in-app et modifier son style dans votre application Roku à l’aide d’une palette standard :
Boutons
Champs | Description |
---|---|
click_action |
"URI" ou "NONE" . Utilisez ce champ pour indiquer si le message in-app doit s’ouvrir sur un lien URI ou fermer le message lorsque vous cliquez dessus. |
id |
La valeur d’ID du bouton lui-même. |
text |
Le texte à afficher sur le bouton. |
uri |
Vos utilisateurs URI seront envoyés vers en fonction de votre click_action . Ce champ doit être inclus lorsque click_action est "URI" . |
Keep in mind, you’ll need to implement your own custom UI since in-app messaging is supported via headless UI using the Swift SDK—which does not include any default UI or views for tvOS.
Conditions préalables
Avant de pouvoir utiliser cette fonctionnalité, vous devrez intégrer le SDK Swift Braze.
Enabling in-app messages
Step 1: Create a new iOS app
In Braze, select Settings > App Settings, then select Add App. Enter a name for your tvOS app, select iOS—not tvOS—then select Add App.
If you select the tvOS checkbox, you will not be able to customize in-app messages for tvOS.
Step 2: Get your app’s API key
In your app settings, select your new tvOS app then take note of your app’s API key. You’ll use this key to configure your app in Xcode.
Step 3: Integrate BrazeKit
Use your app’s API key to integrate the Braze Swift SDK into your tvOS project in Xcode. You only need to integrate BrazeKit from the Braze Swift SDK.
Step 4: Create your custom UI
Because Braze doesn’t provide a default UI for in-app messages on tvOS, you’ll need to customize it yourself. For a full walkthrough, see our step-by-step tutorial: Customizing in-app messages for tvOS. For a sample project, see Braze Swift SDK samples.
Conditions préalables
Avant de pouvoir utiliser cette fonctionnalité, vous devez intégrer le SDK d’Unity Braze.
Message types
Braze offers several default in-app message types, each customizable with messages, images, Font Awesome icons, click actions, analytics, color schemes, and more.
Their basic behavior and traits are defined by the IInAppMessage
interface, in a subclass called InAppMessageBase
. IInAppMessage
also includes a subinterface, IInAppMessageImmersive
, which lets you add close, click-action, and analytics buttons to your app.
Keep in mind, in-app messages containing buttons will include the clickAction
message in the final payload if the click action is added prior to adding the button text.
modal
in-app messages appear in the center of the screen and are framed by a translucent panel. Useful for more critical messaging, they can be equipped with two click-action and analytics-enabled buttons.
This message type is a subclass of InAppMessageImmersiveBase
, an abstract class that implements IInAppMessageImmersive
, giving you the option to add custom functionality to your locally generated in-app messages.
full
in-app messages are useful for maximizing the content and impact of your user communication. The upper half of a full
in-app message contains an image, and the lower half displays text and up to two click action and analytics-enabled buttons.
This message type extends InAppMessageImmersiveBase
, giving you the option to add custom functionality to your locally generated in-app messages.
HTML
in-app messages are useful for creating fully customized user content. User-defined HTML in-app message content is displayed in a WebView
and may optionally contain other rich content, such as images and fonts, allowing for full control over message appearance and functionality.
This message type implements IInAppMessageHtml
, which is a subclass of IInAppMessage
.
Android in-app messages support a JavaScript brazeBridge
interface to call methods on the Braze Android SDK from within your HTML, see our JavaScript bridge page for more details.
We currently do not support the display of custom HTML in-app messages in an iFrame on the iOS and Android platforms.
You can also define custom in-app message views for your app. For a full walkthrough, see Setting custom factories.
Each in-app message type is highly customizable across content, images, icons, click actions, analytics, display, and delivery. They are enumerated types of Braze.InAppMessage
, which defines basic behavior and traits for all in-app messages. For the full list of in-app message properties and usage, see the InAppMessage
class.
These are the available in-app message types in Braze and how they will look like for end-users.
Modal
in-app messages appear in the center of the screen and are framed by a translucent panel. Useful for more critical messaging, they can be equipped with up to two analytics-enabled buttons.
Modal Image
in-app messages appear in the center of the screen and are framed by a translucent panel. These messages are similar to the Modal
type except without header or message text. Useful for more critical messaging, they can be equipped with up to two analytics-enabled buttons.
Full
in-app messages are useful for maximizing the content and impact of your user communication. The upper half of a Full
in-app message contains an image, and the lower half displays text and up to two analytics-enabled buttons.
Full Image
in-app messages are similar to Full
in-app messages except without header or message text. This message type is useful for maximizing the content and impact of your user communication. A Full Image
in-app message contains an image spanning the entire screen, with the option to display up to two analytics-enabled buttons.
HTML
in-app messages are useful for creating fully customized user content. User-defined HTML Full in-app message content is displayed in a WKWebView
and may optionally contain other rich content, such as images and fonts, allowing for full control over message appearance and functionality.
iOS in-app messages support a JavaScript brazeBridge
interface to call methods on the Braze Web SDK from within your HTML, see our best practices for more details.
The following example shows a paginated HTML Full in-app message:
Note that we currently do not support the display of custom HTML in-app messages in an iFrame on the iOS and Android platforms.
Control
in-app messages do not contain a UI component and are used primarily for analytics purposes. This type is used to verify receipt of an in-app message sent to a control group.
For further details about Intelligent Selection and control groups, refer to Intelligent Selection.
Conditions préalables
Avant de pouvoir utiliser cette fonctionnalité, vous devrez intégrer le SDK Xamarin Braze.
Types de messages
Braze propose plusieurs types de messages in-app par défaut, chacun personnalisable avec des messages, des images, des icônes Font Awesome, des actions de clic, des analyses, des schémas de couleurs, et plus encore.
Leur comportement de base et leurs caractéristiques sont définis par l’interface IInAppMessage
dans une sous-classe appelée InAppMessageBase
. IInAppMessage
comprend également une sous-interface, IInAppMessageImmersive
qui vous permet d’ajouter des boutons de fermeture, de clic-action et d’analyse/analytique à votre application.
N’oubliez pas que les messages in-app contenant des boutons incluront le message clickAction
dans la charge utile finale si l’action de clic est ajoutée avant l’ajout du texte du bouton.
Les messages in-app de type modal
apparaissent au centre de l’écran et sont encadrés par un panneau transparent. Ils sont utiles pour les messages plus critiques et peuvent être équipés d’un bouton d’action et d’un bouton activé par analyse.
Ce type de message est une sous-classe de InAppMessageImmersiveBase
une classe abstraite qui implémente IInAppMessageImmersive
, ce qui vous permet d’ajouter des fonctionnalités personnalisées à vos messages in-app générés localement.
full
Les messages in-app sont utiles pour maximiser le contenu et l’impact de votre communication avec les utilisateurs. La moitié supérieure d’un full
message in-app contient une image, et la moitié inférieure affiche le texte et deux boutons d’action permettant l’analyse.
Ce type de message s’étend à InAppMessageImmersiveBase
vous permettant d’ajouter des fonctionnalités personnalisées à vos messages in-app générés localement.
Les messages in-app HTML
sont utiles pour créer un contenu utilisateur entièrement personnalisé. Le contenu du message in-app en HTML défini par l’utilisateur est affiché dans un WebView
et peut éventuellement contenir d’autres contenus enrichis, tels que des images et des polices, permettant un contrôle total de l’apparence et de la fonctionnalité du message.
Ces messages sont des instances de InAppMessageHtml
qui mettent en œuvre la sous-classe IInAppMessage
: IInAppMessageHtml
.
Les messages in-app Android prennent en charge une interface JavaScript brazeBridge
pour appeler des méthodes SDK Braze pour le Web depuis votre HTML. Consultez nos meilleures pratiques pour plus de détails.
Actuellement, nous ne prenons pas en charge l’affichage de messages in-app HTML personnalisés dans un iFrame sur les plateformes iOS et Android.
Vous pouvez également définir des envois de messages in-app personnalisés pour votre application. Pour en savoir plus, consultez la rubrique Création d’usines personnalisées.
Chaque type de message in-app est hautement personnalisable en termes de contenu, d’images, d’icônes, d’actions de clic, d’analyse, d’affichage et de diffusion. Il s’agit de types énumérés de Braze.InAppMessage
, qui définit le comportement et les caractéristiques de base de tous les messages in-app. Pour obtenir la liste complète des propriétés et de l’utilisation des messages in-app, consultez la classeInAppMessage
.
Voici les types de messages in-app disponibles dans Braze et ce à quoi ils ressembleront pour les utilisateurs finaux.
Les messages in-app de type Modal
apparaissent au centre de l’écran et sont encadrés par un panneau transparent. Utiles pour les communications plus critiques, ils peuvent être équipés d’un maximum de deux boutons dotés d’une fonction d’analyse.
Les messages in-app de type Modal Image
apparaissent au centre de l’écran et sont encadrés par un panneau transparent. Ces messages sont similaires au type Modal
, mais sans en-tête ni texte de message. Utiles pour les communications plus critiques, ils peuvent être équipés d’un maximum de deux boutons dotés d’une fonction d’analyse.
Full
Les messages in-app sont utiles pour maximiser le contenu et l’impact de votre communication avec les utilisateurs. La moitié supérieure d’un message in-app Full
contient une image, et la moitié inférieure affiche du texte et jusqu’à deux boutons permettant l’analyse.
Les messages in-app Full Image
sont similaires aux messages in-app Full
, sauf qu’ils ne comportent pas d’en-tête ni de texte de message. Ce type de message est utile pour maximiser le contenu et l’impact de votre communication avec les utilisateurs. Un message in-app Full Image
contient une image qui s’étend sur tout l’écran, avec la possibilité d’afficher jusqu’à deux boutons compatibles avec l’analyse.
Les messages in-app HTML
sont utiles pour créer un contenu utilisateur entièrement personnalisé. Le contenu des messages in-app entièrement en HTML défini par l’utilisateur est affiché dans un WKWebView
et peut éventuellement contenir d’autres contenus enrichis, tels que des images et des polices, permettant un contrôle total de l’apparence et de la fonctionnalité du message.
Les messages in-app IOS prennent en charge une interface JavaScript brazeBridge
pour appeler des méthodes sur le SDK Braze pour le Web depuis votre HTML. Pour plus d’informations, consultez nos meilleures pratiques.
L’exemple suivant montre la mise en page d’un message in-app HTML complet :
Notez que nous ne prenons actuellement pas en charge l’affichage de messages in-app HTML personnalisés dans un iFrame sur les plateformes iOS et Android.
Les messages in-app Control
ne contiennent pas de composant d’interface utilisateur et sont utilisés principalement à des fins d’analyse. Ce type est utilisé pour vérifier la réception d’un message in-app envoyé à un groupe de contrôle.
Pour plus de détails sur la sélection intelligente et les groupes de contrôle, reportez-vous à la section Sélection intelligente.