Mensagem no app
Saiba mais sobre mensagens no app e como configurá-las para o Braze SDK.
Pré-requisitos
Antes de poder usar esse recurso, você precisará integrar o Android Braze SDK. 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.
slideup in-app messages are so-named because they “slide up” or “slide down” from the top or bottom of the screen. They cover a small portion of the screen and provide an effective and non-intrusive messaging capability.
The slideup in-app message object extends InAppMessageBase.
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))
}
}
Pré-requisitos
Antes de usar este recurso, você precisará integrar o SDK Swift Braze. Você também precisará ativar as mensagens no app.
Tipos de mensagens
Cada tipo de mensagem no app é altamente personalizável em termos de conteúdo, imagens, ícones, ações de clique, análise de dados, exibição e entrega. Eles são tipos enumerados de Braze.InAppMessage, que define o comportamento básico e as características de todas as mensagens no app. Para obter a lista completa de propriedades e uso de mensagens no app, consulte a classeInAppMessage .
Estes são os tipos de mensagens no app disponíveis no Braze e como eles serão exibidos para os usuários finais.
Slideup As mensagens no app recebem esse nome porque “deslizam para cima” ou “deslizam para baixo” a partir da parte superior ou inferior da tela. Eles cobrem uma pequena parte da tela e fornecem um recurso de envio de mensagens eficaz e não intrusivo.
Modal As mensagens no app aparecem no centro da tela e são emolduradas por um painel translúcido. Úteis para o envio de mensagens mais críticas, eles podem ser equipados com até dois botões ativados por análise de dados.
Modal Image As mensagens no app aparecem no centro da tela e são emolduradas por um painel translúcido. Essas mensagens são semelhantes ao tipo Modal, mas sem cabeçalho ou texto de mensagem. Úteis para o envio de mensagens mais críticas, eles podem ser equipados com até dois botões ativados por análise de dados.
Full As mensagens no app são úteis para maximizar o conteúdo e o impacto da sua comunicação com o usuário. A metade superior de uma mensagem no app Full contém uma imagem, e a metade inferior exibe texto e até dois botões de análise de dados.
Full Image As mensagens no app são semelhantes às mensagens no app Full, exceto pelo fato de não terem cabeçalho ou texto de mensagem. Esse tipo de mensagem é útil para maximizar o conteúdo e o impacto da sua comunicação com o usuário. Uma mensagem no app Full Image contém uma imagem que abrange toda a tela, com a opção de exibir até dois botões de análise de dados ativados.
HTML As mensagens no app são úteis para criar conteúdo totalmente personalizado para o usuário. HTML definido pelo usuário O conteúdo completo da mensagem no app é exibido em WKWebViewe pode, opcionalmente, conter outros conteúdos avançados, como imagens e fontes, permitindo controle total sobre a aparência e a funcionalidade da mensagem.
As mensagens no app do iOS suportam uma interface JavaScript brazeBridge para chamar métodos no Braze Web SDK a partir do seu HTML; consulte nossas práticas recomendadas para obter mais detalhes.
O exemplo a seguir mostra uma mensagem no app paginada em HTML Full:
Note que atualmente não oferecemos suporte à exibição de mensagens no app em HTML personalizado em um iFrame nas plataformas iOS e Android.
Control As mensagens no app não contêm um componente de interface do usuário e são usadas principalmente para fins de análise de dados. Esse tipo é usado para verificar o recebimento de uma mensagem no app enviada a um grupo de controle.
Para obter mais detalhes sobre a seleção inteligente e os grupos de controle, consulte Seleção inteligente.
Ativação de mensagens no app
Etapa 1: Criar uma implementação de BrazeInAppMessagePresenter
Para permitir que o Braze exiba mensagens no app, crie uma implementação do protocolo BrazeInAppMessagePresenter e atribua-o ao inAppMessagePresenter opcional em sua instância do Braze. Você também pode usar o apresentador padrão do Braze UI instanciando um objeto BrazeInAppMessageUI.
Será necessário importar a biblioteca BrazeUI para acessar a classe BrazeInAppMessageUI.
1
AppDelegate.braze?.inAppMessagePresenter = BrazeInAppMessageUI()
1
AppDelegate.braze.inAppMessagePresenter = [[BrazeInAppMessageUI alloc] init];
Etapa 2: Manusear gatilhos não correspondentes
Implementar BrazeDelegate.(_:noMatchingTriggerForEvent) na classe BrazeDelegate relevante. Quando o Braze não conseguir encontrar um disparador correspondente para um determinado evento, ele chamará esse método automaticamente.
Prerequisites
Before you can use this feature, you’ll need to integrate the Web Braze SDK. Entretanto, não é necessária nenhuma configuração adicional.
Tipos de mensagens
Todas as mensagens no app herdam seu protótipo de InAppMessage, que define o comportamento básico e as características de todas as mensagens no app. As subclasses prototípicas são SlideUpMessage, ModalMessage, FullScreenMessage, e HtmlMessage.
Cada tipo de mensagem no app é personalizável em termos de conteúdo, imagens, ícones, ações de clique, análise de dados, exibição e entrega.
As mensagens no app SlideUp têm esse nome porque, nas plataformas móveis, elas tradicionalmente “deslizam para cima” ou “deslizam para baixo” do topo ou da parte inferior da tela. No Braze Web SDK, essas mensagens são exibidas mais como uma notificação no estilo Growl ou Toast para alinhar com o paradigma dominante da web. Eles cobrem uma pequena parte da tela e fornecem um recurso de envio de mensagens eficaz e não intrusivo.
Modal As mensagens no app aparecem no centro da tela e são emolduradas por um painel translúcido. Úteis para o envio de mensagens mais críticas, eles podem ser capacitados com até dois botões de ação por clique e de análise de dados.
Full As mensagens no app são úteis para maximizar o conteúdo e o impacto da sua comunicação com o usuário. Em janelas de navegador estreitas (por exemplo, na web móvel), mensagem no app full ocupam toda a janela do navegador. Em janelas de navegador maiores, mensagens no app full aparecem de forma semelhante a mensagens no app modal. A metade superior de uma mensagem no app full contém uma imagem, e a metade inferior permite até oito linhas de texto, bem como até dois botões com ação de clique e habilitados para análise de dados.
HTML As mensagens no app são úteis para criar conteúdo totalmente personalizado para o usuário. O conteúdo HTML definido pelo usuário é exibido em um iFrame e pode conter conteúdos avançados, como imagens, fontes, vídeos e elementos interativos, permitindo controle total sobre a aparência e a funcionalidade da mensagem. Esses suportam uma interface JavaScript brazeBridge para chamar métodos no Braze Web SDK de dentro do HTML. Para saber mais, consulte nossas práticas recomendadas.
Para ativar mensagens no app HTML através do Web SDK, você deve fornecer a opção de inicialização allowUserSuppliedJavascript para a Braze, por exemplo, braze.initialize('YOUR-API_KEY', {allowUserSuppliedJavascript: true}). Isto é por razões de segurança. Mensagens HTML no app podem executar JavaScript, então exigimos que um mantenedor do site as ative.
O exemplo a seguir mostra uma mensagem no app HTML paginada:
Pré-requisitos
Antes de poder usar esse recurso, você precisará integrar o Android Braze SDK.
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.
slideup in-app messages are so-named because they “slide up” or “slide down” from the top or bottom of the screen. They cover a small portion of the screen and provide an effective and non-intrusive messaging capability.
The slideup in-app message object extends InAppMessageBase.
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.
Slideup in-app messages are given this name because they “slide up” or “slide down” from the top or bottom of the screen. They cover a small portion of the screen and provide an effective and non-intrusive messaging capability.
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 WKWebViewand 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.
Pré-requisitos
Antes de poder usar esse recurso, você precisará integrar o Flutter Braze SDK.
Tipos de mensagens
O Braze oferece vários tipos de mensagens no app padrão, cada uma personalizável com mensagens, imagens, ícones Font Awesome, ações de clique, análises de dados, esquemas de cores e muito mais.
Seu comportamento básico e suas características são definidos pela IInAppMessage em uma subclasse chamada InAppMessageBase. IInAppMessage também inclui uma subinterface, IInAppMessageImmersiveque permite adicionar botões de fechar, de ação de clique e de análise de dados ao seu app.
Lembre-se de que as mensagens no app que contêm botões incluirão a mensagem clickAction na carga útil final se a ação de clique for adicionada antes da adição do texto do botão.
slideup As mensagens no app são assim chamadas porque “deslizam para cima” ou “deslizam para baixo” a partir da parte superior ou inferior da tela. Eles cobrem uma pequena parte da tela e fornecem um recurso de envio de mensagens eficaz e não intrusivo.
O objeto de mensagem no app slideup estende InAppMessageBase.
modal As mensagens no app aparecem no centro da tela e são emolduradas por um painel translúcido. Úteis para o envio de mensagens mais críticas, eles podem ser equipados com dois botões de ação por clique e com análise de dados ativada.
Esse tipo de mensagem é uma subclasse de InAppMessageImmersiveBaseuma classe abstrata que implementa IInAppMessageImmersive, dando-lhe a opção de adicionar funcionalidade personalizada às mensagens no app geradas localmente.
full As mensagens no app são úteis para maximizar o conteúdo e o impacto da sua comunicação com o usuário. A metade superior de uma mensagem no app full contém uma imagem, e a metade inferior exibe texto e até dois botões de ação de clique e de análise de dados.
Esse tipo de mensagem estende InAppMessageImmersiveBasedando-lhe a opção de adicionar funcionalidade personalizada às mensagens no app geradas localmente.
HTML As mensagens no app são úteis para criar conteúdo totalmente personalizado para o usuário. O conteúdo HTML definido pelo usuário da mensagem no app é exibido em WebView e pode, opcionalmente, conter outros conteúdos avançados, como imagens e fontes, permitindo controle total sobre a aparência e a funcionalidade da mensagem.
Essas instâncias de mensagens de InAppMessageHtmlque implementam a subclasse IInAppMessage: IInAppMessageHtml.
As mensagens no app Android suportam uma interface JavaScript brazeBridge para chamar métodos no Braze Web SDK a partir do seu HTML; consulte nossas práticas recomendadas para obter mais detalhes.
Atualmente, não oferecemos suporte à exibição de mensagens no app em HTML personalizado em um iFrame nas plataformas iOS e Android.
Você também pode definir exibições personalizadas de mensagens no app para o seu aplicativo. Para obter um passo a passo completo, consulte Configuração de fábricas personalizadas.
Cada tipo de mensagem no app é altamente personalizável em termos de conteúdo, imagens, ícones, ações de clique, análise de dados, exibição e entrega. Eles são tipos enumerados de Braze.InAppMessage, que define o comportamento básico e as características de todas as mensagens no app. Para obter a lista completa de propriedades e uso de mensagens no app, consulte a classeInAppMessage .
Estes são os tipos de mensagens no app disponíveis no Braze e como eles serão exibidos para os usuários finais.
Slideup As mensagens no app recebem esse nome porque “deslizam para cima” ou “deslizam para baixo” a partir da parte superior ou inferior da tela. Eles cobrem uma pequena parte da tela e fornecem um recurso de envio de mensagens eficaz e não intrusivo.
Modal As mensagens no app aparecem no centro da tela e são emolduradas por um painel translúcido. Úteis para o envio de mensagens mais críticas, eles podem ser equipados com até dois botões ativados por análise de dados.
Modal Image As mensagens no app aparecem no centro da tela e são emolduradas por um painel translúcido. Essas mensagens são semelhantes ao tipo Modal, mas sem cabeçalho ou texto de mensagem. Úteis para o envio de mensagens mais críticas, eles podem ser equipados com até dois botões ativados por análise de dados.
Full As mensagens no app são úteis para maximizar o conteúdo e o impacto da sua comunicação com o usuário. A metade superior de uma mensagem no app Full contém uma imagem, e a metade inferior exibe texto e até dois botões de análise de dados.
Full Image As mensagens no app são semelhantes às mensagens no app Full, exceto pelo fato de não terem cabeçalho ou texto de mensagem. Esse tipo de mensagem é útil para maximizar o conteúdo e o impacto da sua comunicação com o usuário. Uma mensagem no app Full Image contém uma imagem que abrange toda a tela, com a opção de exibir até dois botões de análise de dados ativados.
HTML As mensagens no app são úteis para criar conteúdo totalmente personalizado para o usuário. HTML definido pelo usuário O conteúdo completo da mensagem no app é exibido em WKWebViewe pode, opcionalmente, conter outros conteúdos avançados, como imagens e fontes, permitindo controle total sobre a aparência e a funcionalidade da mensagem.
As mensagens no app do iOS suportam uma interface JavaScript brazeBridge para chamar métodos no Braze Web SDK a partir do seu HTML; consulte nossas práticas recomendadas para obter mais detalhes.
O exemplo a seguir mostra uma mensagem no app paginada em HTML Full:
Note que atualmente não oferecemos suporte à exibição de mensagens no app em HTML personalizado em um iFrame nas plataformas iOS e Android.
Control As mensagens no app não contêm um componente de interface do usuário e são usadas principalmente para fins de análise de dados. Esse tipo é usado para verificar o recebimento de uma mensagem no app enviada a um grupo de controle.
Para obter mais detalhes sobre a seleção inteligente e os grupos de controle, consulte Seleção inteligente.
Prerequisites
Before you can use this feature, you’ll need to integrate the React Native Braze SDK.
Tipos de mensagens
O Braze oferece vários tipos de mensagens no app padrão, cada uma personalizável com mensagens, imagens, ícones Font Awesome, ações de clique, análises de dados, esquemas de cores e muito mais.
Seu comportamento básico e suas características são definidos pela IInAppMessage em uma subclasse chamada InAppMessageBase. IInAppMessage também inclui uma subinterface, IInAppMessageImmersiveque permite adicionar botões de fechar, de ação de clique e de análise de dados ao seu app.
Lembre-se de que as mensagens no app que contêm botões incluirão a mensagem clickAction na carga útil final se a ação de clique for adicionada antes da adição do texto do botão.
slideup As mensagens no app são assim chamadas porque “deslizam para cima” ou “deslizam para baixo” a partir da parte superior ou inferior da tela. Eles cobrem uma pequena parte da tela e fornecem um recurso de envio de mensagens eficaz e não intrusivo.
O objeto de mensagem no app slideup estende InAppMessageBase.
modal As mensagens no app aparecem no centro da tela e são emolduradas por um painel translúcido. Úteis para o envio de mensagens mais críticas, eles podem ser equipados com dois botões de ação por clique e com análise de dados ativada.
Esse tipo de mensagem é uma subclasse de InAppMessageImmersiveBaseuma classe abstrata que implementa IInAppMessageImmersive, dando-lhe a opção de adicionar funcionalidade personalizada às mensagens no app geradas localmente.
full As mensagens no app são úteis para maximizar o conteúdo e o impacto da sua comunicação com o usuário. A metade superior de uma mensagem no app full contém uma imagem, e a metade inferior exibe texto e até dois botões de ação de clique e de análise de dados.
Esse tipo de mensagem estende InAppMessageImmersiveBasedando-lhe a opção de adicionar funcionalidade personalizada às mensagens no app geradas localmente.
HTML As mensagens no app são úteis para criar conteúdo totalmente personalizado para o usuário. O conteúdo HTML definido pelo usuário da mensagem no app é exibido em WebView e pode, opcionalmente, conter outros conteúdos avançados, como imagens e fontes, permitindo controle total sobre a aparência e a funcionalidade da mensagem.
Essas instâncias de mensagens de InAppMessageHtmlque implementam a subclasse IInAppMessage: IInAppMessageHtml.
As mensagens no app Android suportam uma interface JavaScript brazeBridge para chamar métodos no Braze Web SDK a partir do seu HTML; consulte nossas práticas recomendadas para obter mais detalhes.
Atualmente, não oferecemos suporte à exibição de mensagens no app em HTML personalizado em um iFrame nas plataformas iOS e Android.
Você também pode definir exibições personalizadas de mensagens no app para o seu aplicativo. Para obter um passo a passo completo, consulte Configuração de fábricas personalizadas.
Cada tipo de mensagem no app é altamente personalizável em termos de conteúdo, imagens, ícones, ações de clique, análise de dados, exibição e entrega. Eles são tipos enumerados de Braze.InAppMessage, que define o comportamento básico e as características de todas as mensagens no app. Para obter a lista completa de propriedades e uso de mensagens no app, consulte a classeInAppMessage .
Estes são os tipos de mensagens no app disponíveis no Braze e como eles serão exibidos para os usuários finais.
Slideup As mensagens no app recebem esse nome porque “deslizam para cima” ou “deslizam para baixo” a partir da parte superior ou inferior da tela. Eles cobrem uma pequena parte da tela e fornecem um recurso de envio de mensagens eficaz e não intrusivo.
Modal As mensagens no app aparecem no centro da tela e são emolduradas por um painel translúcido. Úteis para o envio de mensagens mais críticas, eles podem ser equipados com até dois botões ativados por análise de dados.
Modal Image As mensagens no app aparecem no centro da tela e são emolduradas por um painel translúcido. Essas mensagens são semelhantes ao tipo Modal, mas sem cabeçalho ou texto de mensagem. Úteis para o envio de mensagens mais críticas, eles podem ser equipados com até dois botões ativados por análise de dados.
Full As mensagens no app são úteis para maximizar o conteúdo e o impacto da sua comunicação com o usuário. A metade superior de uma mensagem no app Full contém uma imagem, e a metade inferior exibe texto e até dois botões de análise de dados.
Full Image As mensagens no app são semelhantes às mensagens no app Full, exceto pelo fato de não terem cabeçalho ou texto de mensagem. Esse tipo de mensagem é útil para maximizar o conteúdo e o impacto da sua comunicação com o usuário. Uma mensagem no app Full Image contém uma imagem que abrange toda a tela, com a opção de exibir até dois botões de análise de dados ativados.
HTML As mensagens no app são úteis para criar conteúdo totalmente personalizado para o usuário. HTML definido pelo usuário O conteúdo completo da mensagem no app é exibido em WKWebViewe pode, opcionalmente, conter outros conteúdos avançados, como imagens e fontes, permitindo controle total sobre a aparência e a funcionalidade da mensagem.
As mensagens no app do iOS suportam uma interface JavaScript brazeBridge para chamar métodos no Braze Web SDK a partir do seu HTML; consulte nossas práticas recomendadas para obter mais detalhes.
O exemplo a seguir mostra uma mensagem no app paginada em HTML Full:
Note que atualmente não oferecemos suporte à exibição de mensagens no app em HTML personalizado em um iFrame nas plataformas iOS e Android.
Control As mensagens no app não contêm um componente de interface do usuário e são usadas principalmente para fins de análise de dados. Esse tipo é usado para verificar o recebimento de uma mensagem no app enviada a um grupo de controle.
Para obter mais detalhes sobre a seleção inteligente e os grupos de controle, consulte Seleção inteligente.
Modelo de dados
O modelo de mensagem no app está disponível no SDK do React Native. Braze tem quatro tipos de mensagem no app que compartilham o mesmo modelo de dados: slideup, modal, full e HTML full.
Mensagens
O modelo de mensagem no app fornece a base para todas as mensagens no app.
| Propriedade | Descrição |
|---|---|
inAppMessageJsonString |
A representação JSON da mensagem. |
message |
O texto da mensagem. |
header |
O cabeçalho da mensagem. |
uri |
O URI associado à ação de clique do botão. |
imageUrl |
A URL da imagem da mensagem. |
zippedAssetsUrl |
Os ativos compactados preparados para exibir conteúdo HTML. |
useWebView |
Indica se a ação de clique do botão deve redirecionar usando uma visualização da web. |
duration |
A duração de exibição da mensagem. |
clickAction |
O tipo de ação de clique do botão. Os três tipos são: NEWS_FEED, URI e NONE. |
dismissType |
O tipo de fechamento da mensagem. Os dois tipos são: SWIPE e AUTO_DISMISS. |
messageType |
O tipo de mensagem no app suportado pelo SDK. Os quatro tipos são: SLIDEUP, MODAL, FULL e HTML_FULL. |
extras |
O dicionário de extras da mensagem. Valor padrão: [:]. |
buttons |
A lista de botões na mensagem no app. |
toString() |
A mensagem como uma string de representação. |
Para uma referência completa do modelo de mensagem no app, consulte a documentação para Android e para iOS.
Botões
Botões podem ser adicionados às mensagens no app para realizar ações e registrar análise de dados. O modelo de botão fornece a base para todos os botões de mensagem no app.
| Propriedade | Descrição |
|---|---|
text |
O texto no botão. |
uri |
O URI associado à ação de clique do botão. |
useWebView |
Indica se a ação de clique do botão deve redirecionar usando uma visualização da web. |
clickAction |
O tipo de ação de clique processada quando o usuário clica no botão. Os três tipos são: NEWS_FEED, URI e NONE. |
id |
O ID do botão na mensagem. |
toString() |
A representação do botão como uma string. |
Para uma referência completa do modelo de botão, consulte a documentação para Android e para iOS.
Prerequisites
Before you can use this feature, you’ll need to integrate the Roku Braze SDK. Além disso, as mensagens no app só serão enviadas para dispositivos Roku que estejam executando a versão mínima suportada do SDK:
Tipos de mensagens
O Braze oferece vários tipos de mensagens no app padrão, cada uma personalizável com mensagens, imagens, ícones Font Awesome, ações de clique, análises de dados, esquemas de cores e muito mais.
Seu comportamento básico e suas características são definidos pela IInAppMessage em uma subclasse chamada InAppMessageBase. IInAppMessage também inclui uma subinterface, IInAppMessageImmersiveque permite adicionar botões de fechar, de ação de clique e de análise de dados ao seu app.
Lembre-se de que as mensagens no app que contêm botões incluirão a mensagem clickAction na carga útil final se a ação de clique for adicionada antes da adição do texto do botão.
slideup As mensagens no app são assim chamadas porque “deslizam para cima” ou “deslizam para baixo” a partir da parte superior ou inferior da tela. Eles cobrem uma pequena parte da tela e fornecem um recurso de envio de mensagens eficaz e não intrusivo.
O objeto de mensagem no app slideup estende InAppMessageBase.
modal As mensagens no app aparecem no centro da tela e são emolduradas por um painel translúcido. Úteis para o envio de mensagens mais críticas, eles podem ser equipados com dois botões de ação por clique e com análise de dados ativada.
Esse tipo de mensagem é uma subclasse de InAppMessageImmersiveBaseuma classe abstrata que implementa IInAppMessageImmersive, dando-lhe a opção de adicionar funcionalidade personalizada às mensagens no app geradas localmente.
full As mensagens no app são úteis para maximizar o conteúdo e o impacto da sua comunicação com o usuário. A metade superior de uma mensagem no app full contém uma imagem, e a metade inferior exibe texto e até dois botões de ação de clique e de análise de dados.
Esse tipo de mensagem estende InAppMessageImmersiveBasedando-lhe a opção de adicionar funcionalidade personalizada às mensagens no app geradas localmente.
HTML As mensagens no app são úteis para criar conteúdo totalmente personalizado para o usuário. O conteúdo HTML definido pelo usuário da mensagem no app é exibido em WebView e pode, opcionalmente, conter outros conteúdos avançados, como imagens e fontes, permitindo controle total sobre a aparência e a funcionalidade da mensagem.
Essas instâncias de mensagens de InAppMessageHtmlque implementam a subclasse IInAppMessage: IInAppMessageHtml.
As mensagens no app Android suportam uma interface JavaScript brazeBridge para chamar métodos no Braze Web SDK a partir do seu HTML; consulte nossas práticas recomendadas para obter mais detalhes.
Atualmente, não oferecemos suporte à exibição de mensagens no app em HTML personalizado em um iFrame nas plataformas iOS e Android.
Você também pode definir exibições personalizadas de mensagens no app para o seu aplicativo. Para obter um passo a passo completo, consulte Configuração de fábricas personalizadas.
Cada tipo de mensagem no app é altamente personalizável em termos de conteúdo, imagens, ícones, ações de clique, análise de dados, exibição e entrega. Eles são tipos enumerados de Braze.InAppMessage, que define o comportamento básico e as características de todas as mensagens no app. Para obter a lista completa de propriedades e uso de mensagens no app, consulte a classeInAppMessage .
Estes são os tipos de mensagens no app disponíveis no Braze e como eles serão exibidos para os usuários finais.
Slideup As mensagens no app recebem esse nome porque “deslizam para cima” ou “deslizam para baixo” a partir da parte superior ou inferior da tela. Eles cobrem uma pequena parte da tela e fornecem um recurso de envio de mensagens eficaz e não intrusivo.
Modal As mensagens no app aparecem no centro da tela e são emolduradas por um painel translúcido. Úteis para o envio de mensagens mais críticas, eles podem ser equipados com até dois botões ativados por análise de dados.
Modal Image As mensagens no app aparecem no centro da tela e são emolduradas por um painel translúcido. Essas mensagens são semelhantes ao tipo Modal, mas sem cabeçalho ou texto de mensagem. Úteis para o envio de mensagens mais críticas, eles podem ser equipados com até dois botões ativados por análise de dados.
Full As mensagens no app são úteis para maximizar o conteúdo e o impacto da sua comunicação com o usuário. A metade superior de uma mensagem no app Full contém uma imagem, e a metade inferior exibe texto e até dois botões de análise de dados.
Full Image As mensagens no app são semelhantes às mensagens no app Full, exceto pelo fato de não terem cabeçalho ou texto de mensagem. Esse tipo de mensagem é útil para maximizar o conteúdo e o impacto da sua comunicação com o usuário. Uma mensagem no app Full Image contém uma imagem que abrange toda a tela, com a opção de exibir até dois botões de análise de dados ativados.
HTML As mensagens no app são úteis para criar conteúdo totalmente personalizado para o usuário. HTML definido pelo usuário O conteúdo completo da mensagem no app é exibido em WKWebViewe pode, opcionalmente, conter outros conteúdos avançados, como imagens e fontes, permitindo controle total sobre a aparência e a funcionalidade da mensagem.
As mensagens no app do iOS suportam uma interface JavaScript brazeBridge para chamar métodos no Braze Web SDK a partir do seu HTML; consulte nossas práticas recomendadas para obter mais detalhes.
O exemplo a seguir mostra uma mensagem no app paginada em HTML Full:
Note que atualmente não oferecemos suporte à exibição de mensagens no app em HTML personalizado em um iFrame nas plataformas iOS e Android.
Control As mensagens no app não contêm um componente de interface do usuário e são usadas principalmente para fins de análise de dados. Esse tipo é usado para verificar o recebimento de uma mensagem no app enviada a um grupo de controle.
Para obter mais detalhes sobre a seleção inteligente e os grupos de controle, consulte Seleção inteligente.
Ativação de mensagens no app
Etapa 1: Adicionar um observador
Para processar mensagens no app, você pode adicionar um observador em BrazeTask.BrazeInAppMessage:
1
m.BrazeTask.observeField("BrazeInAppMessage", "onInAppMessageReceived")
Etapa 2: Acesso a mensagens disparadas
Então, dentro do seu manipulador, você tem acesso à mensagem no app mais alta que suas campanhas dispararam:
1
2
3
4
sub onInAppMessageReceived()
in_app_message = m.BrazeTask.BrazeInAppMessage
...
end sub
Campos de mensagens
Manuseio
A seguir estão listados os campos que você precisará para gerenciar suas mensagens no app:
| Campos | Descrição |
|---|---|
buttons |
Lista de botões (pode ser uma lista vazia). |
click_action |
"URI" ou "NONE". Use este campo para indicar se a mensagem no app deve abrir um link URI ou fechar a mensagem quando clicado. Quando não houver botões, isso deve acontecer quando o usuário clicar em “OK” quando a mensagem no app for exibida. |
dismiss_type |
"AUTO_DISMISS" ou "SWIPE". Use este campo para indicar se sua mensagem no app será automaticamente descartada ou se exigirá um deslize para ser descartada. |
display_delay |
Quanto tempo (segundos) esperar até exibir a mensagem no app. |
duration |
Por quanto tempo (milissegundos) a mensagem deve ser exibida quando dismiss_type é configurado para "AUTO_DISMISS". |
extras |
Pares chave-valor. |
header |
O texto do cabeçalho. |
id |
O ID usado para registrar impressões ou cliques. |
image_url |
URL da imagem da mensagem no app. |
message |
Texto do corpo da mensagem. |
uri |
Seus usuários de URI serão enviados com base no seu click_action. Este campo deve ser incluído quando click_action é "URI". |
Para mensagens no app contendo botões, a mensagem click_action também será incluída na carga útil final se a ação de clique for adicionada antes de adicionar o texto do botão.
Estilo
Existem também vários campos de estilo que você pode escolher usar no dashboard:
| Campos | Descrição |
|---|---|
bg_color |
Cor de fundo. |
close_button_color |
Cor do botão de fechar. |
frame_color |
A cor da sobreposição da tela de fundo. |
header_text_color |
Cor do texto do cabeçalho. |
message_text_color |
Cor do texto da mensagem. |
text_align |
“INÍCIO”, “CENTRO” ou “FIM”. Seu alinhamento de texto selecionado. |
Alternativamente, você poderia implementar a mensagem no app e estilizar dentro do seu aplicativo Roku usando uma paleta padrão:
Botões
| Campos | Descrição |
|---|---|
click_action |
"URI" ou "NONE". Use este campo para indicar se a mensagem no app deve abrir um link URI ou fechar a mensagem quando clicado. |
id |
O valor de ID do próprio botão. |
text |
O texto a ser exibido no botão. |
uri |
Seus usuários de URI serão enviados com base no seu click_action. Este campo deve ser incluído quando click_action é "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.
Pré-requisitos
Antes de usar este recurso, você precisará integrar o 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.
Pré-requisitos
Antes de poder usar esse recurso, você precisará integrar o Unity 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.
slideup in-app messages are so-named because they “slide up” or “slide down” from the top or bottom of the screen. They cover a small portion of the screen and provide an effective and non-intrusive messaging capability.
The slideup in-app message object extends InAppMessageBase.
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.
Slideup in-app messages are given this name because they “slide up” or “slide down” from the top or bottom of the screen. They cover a small portion of the screen and provide an effective and non-intrusive messaging capability.
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 WKWebViewand 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.
Pré-requisitos
Antes de poder usar este recurso, você precisará integrar o SDK do Xamarin Braze.
Tipos de mensagens
O Braze oferece vários tipos de mensagens no app padrão, cada uma personalizável com mensagens, imagens, ícones Font Awesome, ações de clique, análises de dados, esquemas de cores e muito mais.
Seu comportamento básico e suas características são definidos pela IInAppMessage em uma subclasse chamada InAppMessageBase. IInAppMessage também inclui uma subinterface, IInAppMessageImmersiveque permite adicionar botões de fechar, de ação de clique e de análise de dados ao seu app.
Lembre-se de que as mensagens no app que contêm botões incluirão a mensagem clickAction na carga útil final se a ação de clique for adicionada antes da adição do texto do botão.
slideup As mensagens no app são assim chamadas porque “deslizam para cima” ou “deslizam para baixo” a partir da parte superior ou inferior da tela. Eles cobrem uma pequena parte da tela e fornecem um recurso de envio de mensagens eficaz e não intrusivo.
O objeto de mensagem no app slideup estende InAppMessageBase.
modal As mensagens no app aparecem no centro da tela e são emolduradas por um painel translúcido. Úteis para o envio de mensagens mais críticas, eles podem ser equipados com dois botões de ação por clique e com análise de dados ativada.
Esse tipo de mensagem é uma subclasse de InAppMessageImmersiveBaseuma classe abstrata que implementa IInAppMessageImmersive, dando-lhe a opção de adicionar funcionalidade personalizada às mensagens no app geradas localmente.
full As mensagens no app são úteis para maximizar o conteúdo e o impacto da sua comunicação com o usuário. A metade superior de uma mensagem no app full contém uma imagem, e a metade inferior exibe texto e até dois botões de ação de clique e de análise de dados.
Esse tipo de mensagem estende InAppMessageImmersiveBasedando-lhe a opção de adicionar funcionalidade personalizada às mensagens no app geradas localmente.
HTML As mensagens no app são úteis para criar conteúdo totalmente personalizado para o usuário. O conteúdo HTML definido pelo usuário da mensagem no app é exibido em WebView e pode, opcionalmente, conter outros conteúdos avançados, como imagens e fontes, permitindo controle total sobre a aparência e a funcionalidade da mensagem.
Essas instâncias de mensagens de InAppMessageHtmlque implementam a subclasse IInAppMessage: IInAppMessageHtml.
As mensagens no app Android suportam uma interface JavaScript brazeBridge para chamar métodos no Braze Web SDK a partir do seu HTML; consulte nossas práticas recomendadas para obter mais detalhes.
Atualmente, não oferecemos suporte à exibição de mensagens no app em HTML personalizado em um iFrame nas plataformas iOS e Android.
Você também pode definir exibições personalizadas de mensagens no app para o seu aplicativo. Para obter um passo a passo completo, consulte Configuração de fábricas personalizadas.
Cada tipo de mensagem no app é altamente personalizável em termos de conteúdo, imagens, ícones, ações de clique, análise de dados, exibição e entrega. Eles são tipos enumerados de Braze.InAppMessage, que define o comportamento básico e as características de todas as mensagens no app. Para obter a lista completa de propriedades e uso de mensagens no app, consulte a classeInAppMessage .
Estes são os tipos de mensagens no app disponíveis no Braze e como eles serão exibidos para os usuários finais.
Slideup As mensagens no app recebem esse nome porque “deslizam para cima” ou “deslizam para baixo” a partir da parte superior ou inferior da tela. Eles cobrem uma pequena parte da tela e fornecem um recurso de envio de mensagens eficaz e não intrusivo.
Modal As mensagens no app aparecem no centro da tela e são emolduradas por um painel translúcido. Úteis para o envio de mensagens mais críticas, eles podem ser equipados com até dois botões ativados por análise de dados.
Modal Image As mensagens no app aparecem no centro da tela e são emolduradas por um painel translúcido. Essas mensagens são semelhantes ao tipo Modal, mas sem cabeçalho ou texto de mensagem. Úteis para o envio de mensagens mais críticas, eles podem ser equipados com até dois botões ativados por análise de dados.
Full As mensagens no app são úteis para maximizar o conteúdo e o impacto da sua comunicação com o usuário. A metade superior de uma mensagem no app Full contém uma imagem, e a metade inferior exibe texto e até dois botões de análise de dados.
Full Image As mensagens no app são semelhantes às mensagens no app Full, exceto pelo fato de não terem cabeçalho ou texto de mensagem. Esse tipo de mensagem é útil para maximizar o conteúdo e o impacto da sua comunicação com o usuário. Uma mensagem no app Full Image contém uma imagem que abrange toda a tela, com a opção de exibir até dois botões de análise de dados ativados.
HTML As mensagens no app são úteis para criar conteúdo totalmente personalizado para o usuário. HTML definido pelo usuário O conteúdo completo da mensagem no app é exibido em WKWebViewe pode, opcionalmente, conter outros conteúdos avançados, como imagens e fontes, permitindo controle total sobre a aparência e a funcionalidade da mensagem.
As mensagens no app do iOS suportam uma interface JavaScript brazeBridge para chamar métodos no Braze Web SDK a partir do seu HTML; consulte nossas práticas recomendadas para obter mais detalhes.
O exemplo a seguir mostra uma mensagem no app paginada em HTML Full:
Note que atualmente não oferecemos suporte à exibição de mensagens no app em HTML personalizado em um iFrame nas plataformas iOS e Android.
Control As mensagens no app não contêm um componente de interface do usuário e são usadas principalmente para fins de análise de dados. Esse tipo é usado para verificar o recebimento de uma mensagem no app enviada a um grupo de controle.
Para obter mais detalhes sobre a seleção inteligente e os grupos de controle, consulte Seleção inteligente.
Editar esta página no GitHub