Desencadenar mensajes dentro de la aplicación
Aprende a desencadear mensajes dentro de la aplicación a través del SDK de Braze.
Desencadenantes y entrega de mensajes
Los mensajes dentro de la aplicación se desencadenan cuando el SDK registra uno de los siguientes tipos de eventos personalizados: Session Start,Push Click Any Purchase, Specific Purchase, yCustom Event (los dos últimos contienen filtros de propiedades robustos).
Al inicio de la sesión de un usuario, Braze entregará todos los mensajes dentro de la aplicación elegibles a tu dispositivo, al tiempo que precargará los activos para minimizar la latencia de visualización. Si el evento desencadenante tiene más de un mensaje dentro de la aplicación elegible, solo se entregará el mensaje con la prioridad más alta. Para obtener más información, consulta Ciclo de vida de la sesión.
Los mensajes dentro de la aplicación no se pueden desencadenar a través de la API ni mediante eventos de la API, solo mediante eventos personalizados registrados por el SDK. Para obtener más información sobre el registro, consulta Registro de eventos personalizados.
Pares clave-valor
Cuando creas una campaña en Braze, puedes establecer pares clave-valor como extras, que el objeto de mensajería dentro de la aplicación puede utilizar para enviar datos a tu aplicación.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
import * as braze from "@braze/web-sdk";
braze.subscribeToInAppMessage(function(inAppMessage) {
// control group messages should always be "shown"
// this will log an impression and not show a visible message
if (inAppMessage instanceof braze.ControlMessage) {
return braze.showInAppMessage(inAppMessage);
}
if (inAppMessage instanceof braze.InAppMessage) {
const extras = inAppMessage.extras;
if (extras) {
for (const key in extras) {
console.log("key: " + key + ", value: " + extras[key]);
}
}
}
braze.showInAppMessage(inAppMessage);
});
1
Map<String, String> getExtras()
1
extras: Map<String, String>
Para obtener más información, consulta el KDoc.
El siguiente ejemplo utiliza lógica personalizada para configurar la presentación de un mensaje dentro de la aplicación basándose en sus pares clave-valor en extras. Para ver un ejemplo completo de aplicación personalizada, consulta nuestra aplicación de muestra.
1
2
3
4
let customization = message.extras["custom-display"] as? String
if customization == "colorful-slideup" {
// Perform your custom logic.
}
1
2
3
4
5
6
if ([message.extras[@"custom-display"] isKindOfClass:[NSString class]]) {
NSString *customization = message.extras[@"custom-display"];
if ([customization isEqualToString:@"colorful-slideup"]) {
// Perform your custom logic.
}
}
Desactivación de los activadores automáticos
De forma predeterminada, los mensajes dentro de la aplicación se desencadenan automáticamente. Para desactivar esta función:
Elimina la llamada abraze.automaticallyShowInAppMessages() dentro de tu fragmento de código de carga y, a continuación, crea una lógica personalizada para gestionar la visualización o no de un mensaje dentro de la aplicación.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
braze.subscribeToInAppMessage(function(inAppMessage) {
// control group messages should always be "shown"
// this will log an impression and not show a visible message
if (inAppMessage.isControl) { // v4.5.0+, otherwise use `inAppMessage instanceof braze.ControlMessage`
return braze.showInAppMessage(inAppMessage);
}
// Display the in-app message. You could defer display here by pushing this message to code within your own application.
// If you don't want to use the display capabilities in Braze, you could alternatively pass the in-app message to your own display code here.
if ( should_show_the_message_according_to_your_custom_logic ) {
braze.showInAppMessage(inAppMessage);
} else {
// do nothing
}
});
Si llamasbraze.showInAppMessagesin quitarbraze.automaticallyShowInAppMessages(), los mensajes pueden aparecer dos veces.
Para obtener un control más avanzado sobre la sincronización de los mensajes, incluyendo el aplazamiento y la restauración de mensajes desencadenados, consulta nuestro tutorial: Aplazamiento y restauración de mensajes desencadenados.
- Implementa el
IInAppMessageManagerListenerpara establecer un oyente personalizado. - Actualiza tu
beforeInAppMessageDisplayed()método para que devuelvaInAppMessageOperation.DISCARD.
Para obtener un control más avanzado sobre la sincronización de los mensajes, incluyendo la visualización posterior y la reincorporación a la cola, consulta nuestra página Personalización de mensajes.
- Implementa el
BrazeInAppMessageUIDelegatedelegado en tu aplicación. Para obtener una guía completa, consulta el Tutorial: Interfaz de usuario de mensajes dentro de la aplicación. - Actualiza tu método delegado
inAppMessage(_:displayChoiceForMessage:)para que devuelva.discard.
Para obtener un control más avanzado sobre la sincronización de los mensajes, incluyendo el aplazamiento y la restauración de mensajes desencadenados, consulta nuestro tutorial: Aplazamiento y restauración de mensajes desencadenados.
- Verifica que estás utilizando el inicializador de integración automática, que está habilitado de forma predeterminada en las versiones
2.2.0y posteriores. - Define la operación de mensajes dentro de la aplicación predeterminada en
DISCARDañadiendo la siguiente línea a tu archivobraze.xml.1
<string name="com_braze_flutter_automatic_integration_iam_operation">DISCARD</string>
En Android, deselecciona Mostrar automáticamente mensajes dentro de la aplicación en el editor de configuración de Braze. También puedes configurarcom_braze_inapp_show_inapp_messages_automatically enfalse en el archivo braze.xml.
La operación inicial de visualización de mensajes dentro de la aplicación se puede configurar en Braze utilizando la opción «Operación inicial de visualización del administrador de mensajes dentro de la aplicación».
Para iOS, configura los oyentes de objetos del juego en el editor de configuración de Braze y asegúrate de que la opción «Braze muestra mensajes dentro de la aplicación» no esté seleccionada.
La operación inicial de visualización de mensajes dentro de la aplicación se puede configurar en Braze utilizando la opción «Operación inicial de visualización del administrador de mensajes dentro de la aplicación».
Anular el límite de velocidad predeterminado
De forma predeterminada, puedes enviar un mensaje dentro de la aplicación una vez cada 30 segundos. Para anular esto, añade la siguiente propiedad a tu archivo de configuración antes de que se inicialice la instancia de Braze. Este valor se utilizará como nuevo límite de velocidad en segundos.
1
2
// Sets the minimum time interval between triggered in-app messages to 5 seconds instead of the default 30
braze.initialize('YOUR-API-KEY', { minimumIntervalBetweenTriggerActionsInSeconds: 5 })
1
<integer name="com_braze_trigger_action_minimum_time_interval_seconds">5</integer>
1
2
3
4
5
6
7
8
let configuration = Braze.Configuration(
apiKey: "YOUR-APP-IDENTIFIER-API-KEY",
endpoint: "YOUR-BRAZE-ENDPOINT"
)
// Sets the minimum trigger time interval to 5 seconds
configuration.triggerMinimumTimeInterval = 5
let braze = Braze(configuration: configuration)
AppDelegate.braze = braze
1
2
3
4
5
6
7
BRZConfiguration *configuration =
[[BRZConfiguration alloc] initWithApiKey:@"<BRAZE_API_KEY>"
endpoint:@"<BRAZE_ENDPOINT>"];
// Sets the minimum trigger time interval to 5 seconds
configuration.triggerMinimumTimeInterval = 5;
Braze *braze = [BrazePlugin initBraze:configuration];
AppDelegate.braze = braze;
Activación manual de mensajes desencadenados
De forma predeterminada, los mensajes dentro de la aplicación se desencadenan automáticamente cuando el SDK registra un evento personalizado. Sin embargo, además de esto, puedes desencadear mensajes manualmente utilizando los siguientes métodos.
Uso de un evento del lado del servidor del servidor
En este momento, el SDK de Web Braze no admite el envío manual de mensajes mediante eventos del lado del servidor.
Para desencadenar un mensaje dentro de la aplicación mediante un evento enviado por el servidor, envía una notificación push silenciosa al dispositivo, lo que permite que una devolución de llamada push personalizada registre un evento basado en SDK. Este evento desencadenará el mensaje dentro de la aplicación dirigido al usuario.
Paso 1: Crea una devolución de llamada push para recibir el push silencioso
Registra tu devolución de llamada push personalizada para escuchar una notificación push silenciosa específica. Para obtener más información, consulta Configuración de notificaciones push.
Se registrarán dos eventos para que se entregue el mensaje dentro de la aplicación, uno por parte del servidor y otro desde dentro de tu devolución de llamada push personalizada. Para asegurarte de que no se duplica el mismo evento, el evento registrado desde dentro de tu devolución de llamada push debe seguir una convención de nomenclatura genérica, por ejemplo, “evento de desencadenamiento de mensaje dentro de la aplicación”, y no el mismo nombre que el evento enviado por el servidor. Si no se hace así, la segmentación y los datos de usuario pueden verse afectados por el registro de sucesos duplicados para una única acción de usuario.
1
2
3
4
5
6
7
8
9
10
11
Braze.getInstance(context).subscribeToPushNotificationEvents(event -> {
final Bundle kvps = event.getNotificationPayload().getBrazeExtras();
if (kvps.containsKey("IS_SERVER_EVENT")) {
BrazeProperties eventProperties = new BrazeProperties();
// The campaign name is a string extra that clients can include in the push
String campaignName = kvps.getString("CAMPAIGN_NAME");
eventProperties.addProperty("campaign_name", campaignName);
Braze.getInstance(context).logCustomEvent("IAM Trigger", eventProperties);
}
});
1
2
3
4
5
6
7
8
9
10
11
Braze.getInstance(applicationContext).subscribeToPushNotificationEvents { event ->
val kvps = event.notificationPayload.brazeExtras
if (kvps.containsKey("IS_SERVER_EVENT")) {
val eventProperties = BrazeProperties()
// The campaign name is a string extra that clients can include in the push
val campaignName = kvps.getString("CAMPAIGN_NAME")
eventProperties.addProperty("campaign_name", campaignName)
Braze.getInstance(applicationContext).logCustomEvent("IAM Trigger", eventProperties)
}
}
Paso 2: Crear una campaña push
Crea una campaña push silenciosa desencadenada a través del evento enviado por el servidor.

La campaña push debe incluir extras de par clave-valor que indiquen que esta campaña push se envía para registrar un evento personalizado del SDK. Este evento se utilizará para desencadenar el mensaje dentro de la aplicación.

El código de ejemplo de devolución de llamada push anterior reconoce los pares clave-valor y registra el evento personalizado SDK apropiado.
Si quieres incluir propiedades del evento para adjuntarlas a tu evento “desencadenador de mensajes dentro de la aplicación”, puedes hacerlo pasándolas a los pares clave-valor de la carga útil push. En este ejemplo, se ha incluido el nombre de la campaña del mensaje dentro de la aplicación posterior. Tu devolución de llamada push personalizada puede entonces pasar el valor como parámetro de la propiedad del evento al registrar el evento personalizado.
Paso 3: Crea una campaña de mensajes dentro de la aplicación
Crea tu campaña de mensajes dentro de la aplicación visible para el usuario en el panel de Braze. Esta campaña debe tener una entrega basada en acciones y desencadenarse desde el evento personalizado registrado desde dentro de tu devolución de llamada push personalizada.
En el siguiente ejemplo, el mensaje específico dentro de la aplicación que se va a desencadenar se ha configurado enviando la propiedad del evento como parte del push silencioso inicial.

Si se registra un evento enviado por el servidor mientras la aplicación no está en primer plano, el evento se registrará, pero no se mostrará el mensaje dentro de la aplicación. Si quieres que el evento se retrase hasta que la aplicación esté en primer plano, debes incluir una comprobación en tu receptor push personalizado para descartar o retrasar el evento hasta que la aplicación haya entrado en primer plano.
Paso 1: Manejar el push silencioso y los pares clave-valor
Implementa la siguiente función y llámala dentro del métodoapplication(_:didReceiveRemoteNotification:fetchCompletionHandler:)::
1
2
3
4
5
6
func handleExtras(userInfo: [AnyHashable : Any]) {
print("A push was received")
if userInfo != nil && (userInfo["IS_SERVER_EVENT"] as? String) != nil && (userInfo["CAMPAIGN_NAME"] as? String) != nil {
AppDelegate.braze?.logCustomEvent("IAM Trigger", properties: ["campaign_name": userInfo["CAMPAIGN_NAME"]])
}
}
1
2
3
4
5
6
- (void)handleExtrasFromPush:(NSDictionary *)userInfo {
NSLog(@"A push was received.");
if (userInfo !=nil && userInfo[@"IS_SERVER_EVENT"] !=nil && userInfo[@"CAMPAIGN_NAME"]!=nil) {
[AppDelegate.braze logCustomEvent:@"IAM Trigger" properties:@{@"campaign_name": userInfo[@"CAMPAIGN_NAME"]}];
}
};
Cuando se reciba el push silencioso, se registrará un evento “desencadenado de mensaje dentro de la aplicación” registrado en el SDK contra el perfil de usuario.
Debido a que se utiliza un mensaje push para registrar un evento personalizado registrado en SDK, Braze necesitará almacenar un token de notificaciones push para cada usuario para habilitar esta solución. Para los usuarios de iOS, Braze sólo almacenará un token a partir del momento en que un usuario haya recibido el aviso push del sistema operativo. Antes de esto, el usuario no será localizable mediante push, y la solución anterior no será posible.
Paso 2: Crea una campaña push silenciosa
Crea una campaña push silenciosa que se desencadene a través del evento enviado por el servidor.

La campaña push debe incluir extras de par clave-valor, que indiquen que esta campaña push se envía para registrar un evento personalizado del SDK. Este evento se utilizará para desencadenar el mensaje dentro de la aplicación.

El código del método application(_:didReceiveRemoteNotification:fetchCompletionHandler:) comprueba si hay una clave IS_SERVER_EVENT y registrará un evento personalizado del SDK si la hay.
Puedes modificar el nombre o las propiedades del evento enviando el valor deseado dentro de los extras del par clave-valor de la carga útil push. Al registrar el evento personalizado, estos extras se pueden utilizar como parámetro del nombre del evento o como propiedad del evento.
Paso 3: Crea una campaña de mensajes dentro de la aplicación
Crea tu campaña de mensajes dentro de la aplicación visible para el usuario en el panel de Braze. Esta campaña debe tener una entrega basada en acciones y desencadenarse desde el evento personalizado registrado en el método application(_:didReceiveRemoteNotification:fetchCompletionHandler:).
En el siguiente ejemplo, el mensaje específico dentro de la aplicación que se va a desencadenar se ha configurado enviando la propiedad del evento como parte del push silencioso inicial.

Ten en cuenta que estos mensajes dentro de la aplicación sólo se desencadenarán si se recibe el push silencioso mientras la aplicación está en primer plano.
Mostrar un mensaje predefinido
Para mostrar manualmente un mensaje dentro de la aplicación predefinido, utiliza el siguiente método:
Para el SDK web, utilizabraze.showInAppMessage(inAppMessage) para mostrar cualquier mensaje dentro de la aplicación. Para obtener más información y ver un ejemplo, consulta Mostrar un mensaje en tiempo real.
1
BrazeInAppMessageManager.getInstance().addInAppMessage(inAppMessage);
1
BrazeInAppMessageManager.getInstance().addInAppMessage(inAppMessage)
1
2
3
if let inAppMessage = AppDelegate.braze?.inAppMessagePresenter?.nextAvailableMessage() {
AppDelegate.braze?.inAppMessagePresenter?.present(message: inAppMessage)
}
Mostrar un mensaje en tiempo real
También puedes crear y mostrar mensajes dentro de la aplicación en tiempo real, utilizando las mismas opciones de personalización disponibles en el panel. Para hacerlo:
1
2
3
4
// Displays a slideup type in-app message.
var message = new braze.SlideUpMessage("Welcome to Braze! This is an in-app message.");
message.slideFrom = braze.InAppMessage.SlideFrom.TOP;
braze.showInAppMessage(message);
1
2
3
// Initializes a new slideup type in-app message and specifies its message.
InAppMessageSlideup inAppMessage = new InAppMessageSlideup();
inAppMessage.setMessage("Welcome to Braze! This is a slideup in-app message.");
1
2
3
// Initializes a new slideup type in-app message and specifies its message.
val inAppMessage = InAppMessageSlideup()
inAppMessage.message = "Welcome to Braze! This is a slideup in-app message."
No muestres mensajes dentro de la aplicación cuando el teclado de software se muestra en la pantalla, ya que la representación no está definida en esta circunstancia.
Llama manualmente alpresent(message:)método en tu inAppMessagePresenter. Por ejemplo:
1
2
3
4
let customInAppMessage = Braze.InAppMessage.slideup(
.init(message: "YOUR_CUSTOM_SLIDEUP_MESSAGE", slideFrom: .bottom, themes: .defaults)
)
AppDelegate.braze?.inAppMessagePresenter?.present(message: customInAppMessage)
1
2
3
4
5
6
7
8
9
BRZInAppMessageRaw *customInAppMessage = [[BRZInAppMessageRaw alloc] init];
customInAppMessage.type = BRZInAppMessageRawTypeSlideup;
customInAppMessage.message = @"YOUR_CUSTOM_SLIDEUP_MESSAGE";
customInAppMessage.slideFrom = BRZInAppMessageRawSlideFromBottom;
customInAppMessage.themes = @{
@"light": BRZInAppMessageRawTheme.defaultLight,
@"dark": BRZInAppMessageRawTheme.defaultDark
};
[AppDelegate.braze.inAppMessagePresenter presentMessage:customInAppMessage];
Al crear tu propio mensaje dentro de la aplicación, te excluyes de cualquier seguimiento de análisis y tendrás que gestionar manualmente el registro de clics e impresiones utilizando tu message.context.
Para mostrar el siguiente mensaje de la pila, utiliza elDisplayNextInAppMessage()método . Los mensajes se guardarán en esta pila si se BrazeUnityInAppMessageDisplayActionType.IAM_DISPLAY_LATEReligeDISPLAY_LATER o como acción de visualización de mensajes dentro de la aplicación.
1
Appboy.AppboyBinding.DisplayNextInAppMessage();
Mensajes de intención de salida para la Web
Los mensajes de intención de salida son mensajes no intrusivos que se muestran dentro de la aplicación y se utilizan para comunicar información importante a los visitantes antes de que abandonen tu sitio web.
Para configurar activadores para estos tipos de mensajes en el SDK web, implementa una biblioteca de intención de salida en tu sitio web (como la biblioteca de código abierto de ouibounce) y, a continuación, utiliza el siguiente código para registrarlo'exit intent'como un evento personalizado en Braze. Ahora, tus futuras campañas de mensajes dentro de la aplicación pueden utilizar este tipo de mensaje como desencadenante de eventos personalizados.
1
2
3
var _ouibounce = ouibounce(false, {
callback: function() { braze.logCustomEvent('exit intent'); }
});
Editar esta página en GitHub