Paires clé-valeur
Braze vous permet d’envoyer des charges utiles de données supplémentaires aux appareils utilisateur via des paires clé-valeur. Cette fonctionnalité est disponible sur les canaux de communication de notifications push, de messages in-app, d’e-mail et de cartes de contenu.
Utilisez des paires clé-valeur pour ajouter des métadonnées structurées aux messages. Ces données supplémentaires peuvent enrichir les messages d’informations contextuelles supplémentaires susceptibles d’influencer le rendu ou le traitement d’un message.
Les paires clé-valeur étant des métadonnées, ces données ne sont pas nécessairement visibles par le destinataire, mais peuvent être utilisées par vos systèmes ou processus connectés pour personnaliser l’envoi des messages.
Chaque paire est composée de
- Clé : L’identifiant (exemple :
utm_source
) - Avantage – Les données associées (exemple :
newsletter
)
Cas d’utilisation
Voici quelques exemples de cas d’utilisation pour l’ajout de métadonnées avec des paires clé-valeur :
- Paramètres de suivi : Attacher des paramètres UTM à des fins d’analyse/analytique (si utilisé comme adjectif)
- Clé :
utm_campaign
- Valeur :
spring_sale
- Clé :
- Tags personnalisés : Ajout de tags pour le routage ou la catégorisation interne
- Clé :
priority
- Valeur :
high
- Clé :
- Déclencheurs de comportement : Métadonnées utilisées pour déclencher ou personnaliser des comportements in-app.
- Clé :
deep_link
- Valeur :
app://promo-page
- Clé :
Notifications push
Les paires clé-valeur peuvent être ajoutées aux notifications push Android, iOS et web. Vous pourriez utiliser des paires clé-valeur pour mettre à jour les indicateurs internes et le contenu de l’app ou personnaliser les propriétés des notifications push, telles que la priorisation des alertes, la localisation et les sons.
Dans le compositeur de messages, sélectionnez l’onglet Paramètres, cliquez sur Ajouter une nouvelle paire et spécifiez vos paires clé-valeur.
iOS
Le service de notification push d’Apple (APN) prend en charge les préférences d’alerte et l’envoi de données personnalisées à l’aide de paires clé-valeur. Les APN utilisent la librairie aps
réservée à Apple qui comprend des clés et des valeurs prédéterminées dirigeant les propriétés d’alerte.
Bibliothèque APS
Clé | Type de valeur | Description de la valeur |
---|---|---|
alert | objet chaîne de caractères ou dictionnaire | Pour les entrées de chaîne de caractères, affiche une alerte avec la chaîne de caractères comme message avec les boutons Fermer et Afficher ; pour les entrées non string, affiche une alerte ou une bannière en fonction des propriétés enfant de l’entrée |
badge | chiffre | Régit le numéro affiché en tant que badge sur l’icône de l’application |
sound | chaîne de caractères | Le nom du fichier sonore qui est utilisé comme alerte ; doit être dans le faisceau de l’application ou le dossier Library/Sounds |
content-available | chiffre | Entrer les valeurs d’un signal à l’application, la disponibilité de nouvelles informations lors du lancement ou de la reprise de session |
Bibliothèque des propriétés d’alerte
Clé | Type de valeur | Description de la valeur |
---|---|---|
titre | chaîne de caractères | Une courte chaîne de caractères qu’Apple Watch affiche brièvement dans le cadre d’une notification |
body | chaîne de caractères | Le contenu de la notification push |
title-loc-key | string ou null | Une clé qui définit la chaîne de caractères de titre pour la localisation actuelle du fichier Localizable.strings |
title-loc-args | tableau de chaînes de caractères ou de nul | Valeurs de chaîne de caractères pouvant s’afficher à la place des spécificateurs de format de localisation dans title-loc-key |
action-loc-key | tableau de chaînes de caractères ou de nul | Si cette option est présente, la chaîne de caractères spécifiée définit la localisation des boutons Fermer et Afficher |
loc-key | string ou null | Une clé qui définit le message de notification pour la localisation actuelle à partir du fichier Localizable.strings |
loc-args | tableau de chaînes de caractères | Les valeurs de chaîne de caractères pouvant s’afficher à la place des spécificateurs de format de localisation dans loc-key |
launch-image | chaînes de caractères | Le nom d’un fichier image dans le faisceau d’applications que vous souhaitez utiliser comme image de lancement lorsque les utilisateurs cliquent sur le bouton d’action ou déplacent la diapo d’action |
Le compositeur de messages de Braze gère automatiquement la création des clés suivantes : alerte et ses propriétés, contenu disponible, son et catégorie.
Ces valeurs peuvent être saisies dans l’onglet Paramètres lorsque vous créez un message push. Sélectionnez Options d’alerte et choisissez une clé du dictionnaire d’alertes pour que la clé soit automatiquement renseignée dans une nouvelle entrée clé-valeur.
Lorsque Braze envoie une notification push aux APN, la charge utile sera formatée en tant que JSON.
Charge utile simple
1
2
3
{
"aps" : { "alert" : "Message received from Spencer" },
}
Charge utile complexe
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
},
}
Accéder aux paires clé-valeur personnalisées
En plus des valeurs de la charge utile de la bibliothèque aps
, vous pouvez envoyer des paires clé-valeur personnalisées à l’appareil d’un utilisateur. Les valeurs de ces paires sont limitées aux types de primitives : dictionnaire (objet), tableau, chaîne de caractère, nombre et booléen.
Les scénarios d’utilisation pour les paires clé-valeur personnalisées comprennent, sans s’y limiter, les indicateurs internes et la définition du contexte de l’interface utilisateur. Braze vous permet d’envoyer des paires clé-valeur supplémentaires avec une notification push à utiliser comme bon vous semble via votre application dans la clé d’extras. Si vous préférez utiliser une autre clé, assurez-vous que votre application peut gérer cette clé personnalisée.
Vous devez éviter de gérer une clé ou un dictionnaire de niveau supérieur appelé ab dans votre application.
Apple conseille aux clients d’éviter les informations client ou les données sensibles en tant que données de charge utile personnalisées. En outre, Apple recommande que toute action associée à un message d’alerte ne supprime pas les données sur un appareil.
Si vous utilisez l’API du fournisseur HTTP/2, toute charge utile individuelle que vous envoyez aux APN ne peut pas dépasser une taille de 4 096 octets. L’interface binaire héritée, qui sera bientôt dépréciée, prend en charge une taille de charge utile de 2 048 octets seulement.
Campagnes déclenchées par API
Braze vous permet d’envoyer une chaîne de caractères personnalisée de paires clé-valeur, connue sous le nom de extras
. Pour accéder à vos suppléments dans les campagnes déclenchées par API planifiées ou non, dans le tableau de bord, définissez une clé en tant que « example_key » et la valeur en tant que "$json:{"foo": 1, "bar": 1}"
. La console de développement affichera alors le message suivant "extras": { "test": { "foo": 1, "bar": 1 }
Android
Braze vous permet d’envoyer des charges utiles de données supplémentaires dans des notifications push à l’aide de paires clé-valeur.
Charges utiles de données
Comme pour la notification push iOS, vous pouvez envoyer des paires clé-valeur personnalisées sur l’appareil d’un utilisateur.
Certains scénarios d’utilisation pour les paires clé-valeur personnalisées comprennent les indicateurs internes et le réglage du contexte de l’interface utilisateur, mais ils peuvent être utilisés pour tous les objectifs.
Le backend de votre application doit être en mesure de traiter les paires clé-valeur personnalisées pour que les charges utiles de données fonctionnent correctement.
Campagnes déclenchées par API
Braze vous permet d’envoyer une chaîne de caractères personnalisée de paires clé-valeur, connue sous le nom de extras
. Pour accéder à vos suppléments dans les campagnes déclenchées par API planifiées ou non, dans le tableau de bord, définissez une clé en tant que « example_key » et la valeur en tant que "$json:{"foo": 1, "bar": 1}"
. La console de développement affichera alors le message suivant : "extras": { "test": { "foo": 1, "bar": 1 }
.
Options de messagerie FCM
Les notifications push d’Android peuvent être personnalisées avec des options de message FCM. Cela inclut notamment la priorité de notification, le son, le délai, la durée de vie et le caractère escamotable. Ces valeurs peuvent être spécifiées dans l’onglet Paramètres lors de la création d’un message push. Reportez-vous à la section Paramètres avancés de notification push pour plus d’instructions sur la manière de définir ces options dans le compositeur de messages de Braze.
Notifications push silencieuses
Une notification push silencieuse est une notification push qui ne contient aucun message d’alerte ou son, utilisée pour mettre à jour l’interface ou le contenu de votre application en arrière-plan. Ces notifications utilisent des paires clé-valeur pour déclencher ces actions d’application en arrière-plan. Les notifications push silencieuses permettent également de suivre les désinstallations.
Les spécialistes du marketing doivent tester que les notifications push silencieuses déclenchent le comportement attendu avant de les envoyer aux applications des utilisateurs. Après avoir composé votre notification push silencieuse iOS ou Android, assurez-vous de ne cibler qu’un utilisateur test en filtrant sur l’ID externe ou l’adresse e-mail.
Lors du lancement de la campagne, vous devez vérifier que vous n’avez reçu aucune notification push visible sur votre appareil de test.
Le système d’exploitation iOS peut porter des notifications pour certaines fonctionnalités (suivi des désinstallations, géorepérages et Push Stories). Notez que si vous rencontrez des difficultés avec ces fonctionnalités, le blocage des notifications silencieuses d’iOS peut en être la cause.
in-app Messages
Pour ajouter une paire clé-valeur à un message in-app, sélectionnez l’onglet Paramètres dans le compositeur de messages, cliquez sur Ajouter une nouvelle paire et spécifiez vos paires clé-valeur.
Campagnes déclenchées par API
Braze vous permet d’envoyer une chaîne de caractères personnalisée de paires clé-valeur, connue sous le nom de extras
. Pour accéder à vos suppléments dans les campagnes déclenchées par API planifiées ou non, dans le tableau de bord, définissez une clé en tant que « example_key » et la valeur en tant que "$json:{"foo": 1, "bar": 1}"
. La console de développement affichera alors le message suivant : "extras": { "test": { "foo": 1, "bar": 1 }
.
E-mails
SparkPost et SendGrid prennent en charge les paires clé-valeur dans les e-mails. Si vous utilisez Sendgrid, les paires clé-valeur seront envoyées en tant qu’arguments uniques. SendGrid vous permet de joindre un nombre illimité de paires clé-valeur jusqu’à 10 000 octets de données. Ces paires clé-valeur sont visibles dans les publications du Webhook d’événement SendGrid.
Les e-mails ayant rebondi ne fournissent pas de paires clé-valeur à SparkPost ou SendGrid.
Cartes de contenu
Pour ajouter une paire clé-valeur à une carte de contenu, accédez à l’onglet Paramètres du compositeur de messages de Braze et cliquez sur Ajouter une nouvelle paire.