Cette page a été traduite automatiquement et peut contenir des inexactitudes. Pour signaler une erreur de traduction, utilisez le module de commentaires en bas de la table des matières, à droite de la page.

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 Content Cards.

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 :

Paramètres de suivi : Ajout de paramètres UTM à des fins d’analyse
- Clé : utm_campaign
- Valeur : spring_sale
Étiquettes personnalisées : Ajout d’étiquettes pour le routage interne ou la catégorisation
- Clé : priority
- Valeur : high
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 Settings, sélectionnez Add New Pair, 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

Clé	Type de valeur	Description de la valeur
alert	chaîne de caractères ou objet dictionnaire	Pour les entrées de type chaîne, affiche une alerte avec la chaîne comme message avec les boutons Fermer et Afficher ; pour les entrées non-chaîne, affiche une alerte ou une bannière selon les propriétés enfants de l’entrée
badge	nombre	Détermine le nombre affiché comme badge sur l’icône de l’application
sound	chaîne de caractères	Le nom du fichier son à jouer comme alerte ; doit se trouver dans le bundle de l’application ou dans le dossier `Library/Sounds`
content-available	nombre	Les valeurs d’entrée de 1 signalent à l’application la disponibilité de nouvelles informations au lancement ou à la reprise de session

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

Clé	Type de valeur	Description de la valeur
title	chaîne de caractères	Une courte chaîne 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	chaîne de caractères ou null	Une clé qui définit la chaîne de titre pour la localisation actuelle à partir du fichier `Localizable.strings`
title-loc-args	tableau de chaînes de caractères ou null	Valeurs de chaîne pouvant apparaître à la place des spécificateurs de format de localisation du titre dans title-loc-key
action-loc-key	tableau de chaînes de caractères ou null	Si présent, la chaîne spécifiée définit la localisation des boutons Fermer et Afficher
loc-key	chaîne de caractères 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	Valeurs de chaîne pouvant apparaître à 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 bundle de l’application que vous souhaitez utiliser comme image de lancement lorsque les utilisateurs appuient sur le bouton d’action ou font glisser le curseur d’action

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 Settings lors de la création d’un message push. Sélectionnez Alert Options 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

{
    "aps" : { "alert" : "Message received from Spencer" },
}

Payload complexe

{
    "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.

Avertissement

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 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.

Avertissement

Si vous utilisez l’API du fournisseur HTTP/2, chaque payload individuel que vous envoyez aux APNs ne peut pas dépasser une taille de 4 096 octets. L’ancienne interface binaire, qui sera bientôt obsolète, ne prend en charge qu’une taille de payload de 2 048 octets.

Campaigns 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 Campaigns déclenchées par API et les Campaigns 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.

Important

Le backend de votre application doit être capable de traiter les paires clé-valeur personnalisées pour que le payload de données fonctionne correctement.

Campaigns déclenchées par API

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 Settings 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 Campaign, vérifiez que vous n’avez reçu aucune notification push visible sur votre appareil de test.

Remarque

La limitation des notifications silencieuses par iOS peut provoquer les symptômes suivants :

Des indicateurs de suivi des désinstallations inférieurs aux attentes pour les utilisateurs iOS
Une distribution incohérente ou retardée des notifications push silencieuses
Des Push Stories qui ne s’affichent pas
Des Push Stories qui arrivent sans les images, vidéos ou pages attendues

Il s’agit d’une limitation de la plateforme Apple et non d’un problème lié à Braze. iOS peut retarder ou ignorer les notifications en arrière-plan pour certaines fonctionnalités Braze, notamment le suivi des désinstallations et les Push Stories. Pour plus de détails sur ce qu’iOS limite et quand, consultez les limitations iOS.

Messages in-app

Vous pouvez ajouter une paire clé-valeur à un message in-app dans l’éditeur traditionnel en sélectionnant l’onglet Settings, en sélectionnant Add New Pair, puis en spécifiant vos paires clé-valeur.

Remarque

Les paires clé-valeur ne peuvent pas être définies via l’éditeur par glisser-déposer pour les messages in-app.

Campaigns déclenchées par API

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.

Remarque

Les e-mails ayant rebondi ne transmettront pas les paires clé-valeur à SparkPost ou SendGrid.

Onglet Informations d'envoi du composeur d'e-mails dans Braze.

Content Cards

Pour ajouter une paire clé-valeur à une Content Card, accédez à l’onglet Settings dans le composeur de messages Braze et sélectionnez Add New Pair.

Ajouter une paire clé-valeur à une Content Card

New Stuff!