Paires clé-valeur

Cette page explique comment utiliser les paires clé-valeur pour envoyer des payloads de données supplémentaires aux appareils des utilisateurs. Cette fonctionnalité est disponible pour les canaux de communication push, in-app, e-mail et cartes de contenu.

Utilisez les paires clé-valeur pour ajouter des métadonnées structurées à vos messages. Ces payloads de données supplémentaires peuvent enrichir les messages avec des informations contextuelles qui influencent la manière dont un message est affiché ou traité.

Comme les paires clé-valeur sont 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 le traitement des messages.

Chaque paire se compose de :

• Clé : L’identifiant (Exemple : utm_source)
• Valeur : La donnée associée (Exemple : newsletter)

Cas d’utilisation

Voici quelques exemples de cas d’utilisation pour l’ajout de métadonnées avec des paires clé-valeur :

1. Paramètres de suivi : Ajout de paramètres UTM à des fins d’analyse
   • Clé : utm_campaign
   • Valeur : spring_sale
2. Étiquettes personnalisées : Ajout d’étiquettes pour le routage interne ou la catégorisation
   • Clé : priority
   • Valeur : high
3. 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

Notifications push

Des paires clé-valeur peuvent être ajoutées aux notifications push Android, iOS et web. Vous pouvez utiliser les paires clé-valeur pour mettre à jour des indicateurs internes et le contenu de l’application, ou pour personnaliser les propriétés des notifications push, telles que la priorité des alertes, la localisation et les sons.

Dans le composeur de messages, sélectionnez l’onglet Paramètres, sélectionnez Ajouter une nouvelle paire, puis spécifiez vos paires clé-valeur.

iOS

Le service Apple Push Notification (APNs) prend en charge la définition de préférences d’alerte et l’envoi de données personnalisées à l’aide de paires clé-valeur. APNs utilise la bibliothèque réservée par Apple aps, qui comprend des clés et des valeurs prédéterminées régissant les propriétés des alertes.

Bibliothèque APS

Bibliothèque des propriétés d’alerte

Le composeur de messages Braze gère automatiquement la création des clés suivantes : alert et ses propriétés, content-available, sound et category.

Ces valeurs peuvent être saisies dans l’onglet Paramètres lors de la création d’un message push. Sélectionnez Options d’alerte et sélectionnez une clé de dictionnaire d’alerte pour que la clé soit automatiquement renseignée dans une nouvelle entrée clé-valeur.

Lorsque Braze envoie une notification push aux APNs, le payload est formaté en JSON.

Payload simple

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

Payload 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
    },
}

Paires clé-valeur personnalisées

En plus des valeurs de payload 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 primitifs : dictionnaire (objet), tableau, chaîne de caractères, nombre et valeur booléenne.

Les cas d’utilisation des paires clé-valeur personnalisées incluent, entre autres, le suivi d’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, utilisables dans votre application via la clé extras. Si vous préférez utiliser une autre clé, vérifiez que votre application peut gérer cette clé personnalisée.

Apple conseille aux clients d’éviter d’inclure des informations client ou des données sensibles comme données de payload personnalisées. De plus, Apple recommande que toute action associée à un message d’alerte ne supprime pas de données sur un appareil.

Campagnes déclenchées par API

Braze vous permet d’envoyer des paires clé-valeur de chaînes personnalisées, appelées extras. Pour accéder à vos extras dans les campagnes déclenchées par API et les campagnes planifiées déclenchées par API, dans le tableau de bord, définissez une clé comme « example_key » et une valeur comme "$json:{"foo": 1, "bar": 1}". Cela produira une sortie dans la console de développement de type "extras": { "test": { "foo": 1, "bar": 1 }

Android

Braze vous permet d’envoyer des payloads de données supplémentaires dans les notifications push à l’aide de paires clé-valeur.

Payload de données

Comme pour les notifications push iOS, vous pouvez envoyer des paires clé-valeur personnalisées à l’appareil d’un utilisateur.

Certains cas d’utilisation des paires clé-valeur personnalisées incluent le suivi d’indicateurs internes et la définition du contexte de l’interface utilisateur, mais elles peuvent être utilisées à toute fin de votre choix.

Campagnes déclenchées par API

Braze vous permet d’envoyer des paires clé-valeur de chaînes personnalisées, appelées extras. Pour accéder à vos extras dans les campagnes déclenchées par API et les campagnes planifiées déclenchées par API, dans le tableau de bord, définissez une clé comme « example_key » et une valeur comme "$json:{"foo": 1, "bar": 1}". Cela produira une sortie dans la console de développement de type "extras": { "test": { "foo": 1, "bar": 1 }.

Options de messagerie FCM

Les notifications push Android peuvent être davantage personnalisées avec les options de message FCM. Celles-ci incluent la priorité de notification, le son, le délai, la durée de vie et la possibilité de regroupement. Ces valeurs peuvent être spécifiées dans l’onglet Paramètres lors de la création d’un message push. Consultez les paramètres avancés des notifications push pour plus d’instructions sur la configuration de ces options dans le composeur de messages Braze.

Notifications push silencieuses

Une notification push silencieuse est une notification push ne contenant aucun message d’alerte ni 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 alimentent également notre suivi des désinstallations.

Les marketeurs doivent tester que les notifications push silencieuses déclenchent le comportement attendu avant de les envoyer aux utilisateurs de leur application. Après avoir composé votre notification push silencieuse iOS ou Android, assurez-vous de ne cibler qu’un utilisateur test en filtrant par ID utilisateur externe ou adresse e-mail.

Au lancement de la campagne, vérifiez que vous n’avez reçu aucune notification push visible sur votre appareil de test.

Messages in-app

Vous pouvez ajouter une paire clé-valeur à un message in-app dans l’éditeur traditionnel en sélectionnant l’onglet Paramètres, en sélectionnant Ajouter une nouvelle paire, puis en spécifiant vos paires clé-valeur.

Campagnes déclenchées par API

Braze vous permet d’envoyer des paires clé-valeur de chaînes personnalisées, appelées extras. Pour accéder à vos extras dans les campagnes déclenchées par API et les campagnes planifiées déclenchées par API, dans le tableau de bord, définissez une clé comme « example_key » et une valeur comme "$json:{"foo": 1, "bar": 1}". Cela produira une sortie dans la console de développement de type "extras": { "test": { "foo": 1, "bar": 1 }.

E-mails

SparkPost et SendGrid prennent tous deux 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 d’attacher 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énements SendGrid.

Cartes de contenu

Pour ajouter une paire clé-valeur à une carte de contenu, accédez à l’onglet Paramètres dans le composeur de messages Braze et sélectionnez Ajouter une nouvelle paire.