Pares clave-valor

Esta página explica cómo utilizar pares clave-valor para enviar cargas útiles de datos adicionales a dispositivos de usuario. Esta característica está disponible en los canales de mensajería push, dentro de la aplicación, correo electrónico y tarjeta de contenido.

Utiliza pares clave-valor para añadir metadatos estructurados a los mensajes. Estas cargas útiles de datos adicionales pueden enriquecer los mensajes con información contextual adicional que puede influir en la forma en que se representa o procesa un mensaje.

Como los pares clave-valor son metadatos, estos datos no son necesariamente visibles para el destinatario, pero pueden ser utilizados por tus sistemas o procesos conectados para personalizar la gestión de los mensajes.

Cada pareja consta de:

• Clave: El identificador (Ejemplo: utm_source)
• Valor: Los datos asociados (Ejemplo: newsletter)

Ejemplos

Aquí tienes algunos casos de uso de ejemplo para añadir metadatos con pares clave-valor:

1. Parámetros de seguimiento: Adjuntar parámetros UTM con fines de análisis
   • Clave: utm_campaign
   • Valor: spring_sale
2. Etiquetas personalizadas: Añadir etiquetas para enrutamiento interno o categorización
   • Clave: priority
   • Valor: high
3. Desencadenantes del comportamiento: Metadatos utilizados para desencadenar o personalizar comportamientos dentro de la aplicación
   • Clave: deep_link
   • Valor: app://promo-page

Notificaciones push

Se pueden añadir pares clave-valor a las notificaciones push de Android, iOS y Web. Puedes utilizar pares clave-valor para actualizar las métricas internas y el contenido de la aplicación o personalizar las propiedades de las notificaciones push, como la priorización de alertas, la localización y los sonidos.

En el creador de mensajes, selecciona la pestaña Configuración, selecciona Añadir nuevo par y especifica tus pares clave-valor.

iOS

El servicio de notificaciones push de Apple (APN) permite establecer preferencias de alerta y enviar datos personalizados mediante pares clave-valor. APNs hace uso de la biblioteca aps reservada por Apple, que incluye claves y valores predeterminados que rigen las propiedades de las alertas.

Biblioteca APS

Biblioteca de propiedades de alerta

El compositor de mensajes Braze gestiona automáticamente la creación de las siguientes claves: alerta y sus propiedades, contenido-disponible, sonido y categoría.

Estos valores pueden introducirse en la pestaña Configuración al crear un mensaje push. Seleccione Opciones de alerta y seleccione una clave del diccionario de alertas para que la clave se rellene automáticamente en una nueva entrada de clave-valor.

Cuando Braze envía una notificación push a los APN, la carga útil se formateará como JSON.

Carga útil simple

1
2
3
{
    "aps" : { "alert" : "Message received from Spencer" },
}

Carga útil compleja

1
2
3
4
5
6
7
8
9
10
11
12
{
    "aps" : {
        "alert" : {
            "body" : "Hi, welcome to our app!",
            "loc-key" : "France",
            "loc-args" : ["Bonjour", "bienvenue"],
            "action-loc-key" : "Button_Type_1",
            "launch-image" : "Paris"
      },
        "content-available" : 1
    },
}

Pares clave-valor personalizados

Además de los valores de carga útil de la biblioteca aps, puede enviar pares clave-valor personalizados al dispositivo de un usuario. Los valores de estos pares se limitan a los tipos primitivos: diccionario (objeto), matriz, cadena, número y booleano.

Los casos de uso de los pares clave-valor personalizados incluyen, entre otros, el mantenimiento de métricas internas y la configuración del contexto de la interfaz de usuario. Braze te permite enviar pares clave-valor adicionales junto con una notificación push que se utilizará a través de tu aplicación dentro de la clave de extras. Si prefieres utilizar otra clave, confirma que tu aplicación puede manejar esta clave personalizada.

Apple aconseja a sus clientes que eviten incluir información de clientes o cualquier dato sensible como datos de carga útil personalizada. Además, Apple recomienda que ninguna acción asociada a un mensaje de alerta borre los datos de un dispositivo.

Campañas activadas por API

Braze permite enviar pares clave-valor de cadena definidos a medida, conocidos como extras. Para acceder a sus extras en campañas activadas por API y campañas programadas activadas por API, en el panel de control establezca una clave como “example_key”, y un valor como "$json:{"foo": 1, "bar": 1}". Esto dará lugar a una salida de consola de desarrollador de "extras": { "test": { "foo": 1, "bar": 1 }

Android

Braze permite enviar cargas útiles de datos adicionales en las notificaciones push mediante pares clave-valor.

Carga de datos

De forma similar al push de iOS, puedes enviar pares clave-valor personalizados al dispositivo de un usuario.

Algunos casos de uso de los pares clave-valor personalizados incluyen el mantenimiento de métricas internas y el establecimiento del contexto para la interfaz de usuario, pero pueden utilizarse para cualquier propósito que usted elija.

Campañas activadas por API

Braze permite enviar pares clave-valor de cadena definidos a medida, conocidos como extras. Para acceder a sus extras en campañas activadas por API y campañas programadas activadas por API, en el panel de control establezca una clave como “example_key”, y un valor como "$json:{"foo": 1, "bar": 1}". Esto dará lugar a una salida de la consola de desarrollador de "extras": { "test": { "foo": 1, "bar": 1 }.

Opciones de mensajería del FCM

Las notificaciones push de Android pueden personalizarse aún más con las opciones de mensajes de FCM. Entre ellas se encuentran la prioridad de notificación, el sonido, el retardo, la vida útil y la colapsabilidad. Estos valores pueden especificarse en la pestaña Configuración al crear un mensaje push. Consulte Configuración avanzada de notificaciones push para obtener más instrucciones sobre cómo configurar estas opciones en el compositor de mensajes Braze.

Notificaciones push silenciosas

Una notificación push silenciosa es una notificación push que no contiene ningún mensaje de alerta ni sonido y que se utiliza para actualizar la interfaz o el contenido de tu aplicación en segundo plano. Estas notificaciones hacen uso de pares clave-valor para desencadenar estas acciones de la aplicación en segundo plano. Las notificaciones push silenciosas también impulsan nuestro seguimiento de desinstalaciones.

Los profesionales del marketing deben comprobar que las notificaciones push silenciosas desencadenan el comportamiento esperado antes de enviarlas a los usuarios de su aplicación. Después de redactar su notificación push silenciosa para iOS o Android, asegúrese de que solo se dirige a un usuario de prueba filtrando por ID de usuario externo o dirección de correo electrónico.

Tras el lanzamiento de la campaña, debe comprobar que no ha recibido ninguna notificación push visible en su dispositivo de prueba.

Mensajes dentro de la aplicación

Para añadir un par clave-valor a un mensaje dentro de la aplicación, selecciona la pestaña Configuración en el creador de mensajes, selecciona Añadir nuevo par y especifica tus pares clave-valor.

Campañas activadas por API

Braze permite enviar pares clave-valor de cadena definidos a medida, conocidos como extras. Para acceder a sus extras en campañas activadas por API y campañas programadas activadas por API, en el panel de control establezca una clave como “example_key”, y un valor como "$json:{"foo": 1, "bar": 1}". Esto dará lugar a una salida de la consola de desarrollador de "extras": { "test": { "foo": 1, "bar": 1 }.

Correos electrónicos

Tanto SparkPost como SendGrid admiten pares clave-valor en los correos electrónicos. Si utiliza SendGrid, los pares clave-valor se enviarán como argumentos únicos. SendGrid permite adjuntar un número ilimitado de pares clave-valor de hasta 10.000 bytes de datos. Estos pares clave-valor pueden verse en los mensajes del webhook de eventos de SendGrid.

Tarjetas de contenido

Para añadir un par clave-valor a una tarjeta de contenido, ve a la pestaña Configuración del creador de mensajes Braze y selecciona Añadir nuevo par.