Extension de transfert d’événements de l’API Track Events
L’extension de transfert d’événements de l’API Track Events de Braze vous permet d’exploiter les données capturées dans Adobe Experience Platform Edge Network et de les envoyer à Braze sous la forme d’événements côté serveur à l’aide de l’API
/users/track.
Ce document décrit les cas d’usage de l’extension, comment l’installer dans vos bibliothèques de transfert d’événements et comment utiliser ses fonctionnalités dans une règle de transfert d’événements.
L’utilisation du transfert d’événements Adobe peut augmenter votre consommation de points de données Braze. Pour plus d’informations, reportez-vous à la documentation de Braze sur les points de données.
Cas d’usage
Cette extension doit utiliser les données de l’Edge Network dans Braze pour tirer parti de ses capacités d’analyse client et de ciblage.
Par exemple, prenons une organisation de vente au détail avec une présence multicanale (site web et mobile) qui capture des données transactionnelles ou conversationnelles sous forme de données d’événements depuis ses plateformes web et mobiles.
En utilisant diverses règles de tags, ces données sont envoyées à l’Edge Network en temps réel. À partir de là, l’extension de transfert d’événements Braze envoie automatiquement les événements pertinents à Braze depuis le côté serveur.
Limites de débit
| API | Limites de débit |
|---|---|
| User Track | 50 000 requêtes par minute. Consultez la documentation de l’API User Track pour plus de détails. |
Intégration
Étape 1 : Rassembler les informations de configuration requises
Pour connecter le réseau Edge Network à Braze, les éléments suivants sont nécessaires :
| Type de clé | Description |
|---|---|
| Instance Braze | Votre instance Braze peut être obtenue auprès de votre gestionnaire d’onboarding Braze ou consultée sur la page d’aperçu de l’API. |
| Clé API REST Braze | Une clé API REST Braze avec toutes les permissions. Elle peut être créée dans le tableau de bord de Braze depuis Paramètres > Clés API. |
Étape 2 : Créer un secret
Créez un nouveau secret de transfert d’événements et définissez la valeur sur votre clé API Braze. Celui-ci sera utilisé pour authentifier la connexion à votre compte tout en sécurisant la valeur.
Étape 3 : Installer et configurer l’extension Braze
- Pour installer l’extension, créez une propriété de transfert d’événements ou choisissez une propriété existante à modifier.
- Ensuite, sélectionnez Extensions dans la navigation de gauche. Dans l’onglet Catalog, sélectionnez Install sur la carte de l’extension Braze.
- Sur l’écran suivant, saisissez votre instance REST et votre clé API, puis sélectionnez Save lorsque vous avez terminé.
Étape 4 : Créer une règle d’envoi d’événement
Après avoir installé l’extension, créez une nouvelle règle de transfert d’événements et configurez ses conditions selon vos besoins. Lors de la configuration des actions pour la règle, sélectionnez l’extension Braze, puis sélectionnez Send Event comme type d’action.
| Champ | Description |
|---|---|
| External user ID | Un UUID ou GUID long, aléatoire et bien distribué. Si vous choisissez une autre méthode pour nommer vos ID utilisateur, ils doivent également être longs, aléatoires et bien distribués. En savoir plus sur la convention de nommage suggérée pour les ID utilisateur. |
| Braze user ID | Identifiant utilisateur Braze. |
| User alias | Un alias sert d’identifiant utilisateur unique alternatif. Utilisez les alias pour identifier les utilisateurs selon des dimensions différentes de votre ID utilisateur principal. L’objet alias utilisateur est composé de deux parties : un alias_name pour l’identifiant lui-même et un alias_label indiquant le type d’alias. Les utilisateurs peuvent avoir plusieurs alias avec des labels différents, mais un seul alias_name par alias_label. |
Pour associer l’événement à un utilisateur, vous devez renseigner soit le champ External User ID, soit le champ Braze User Identifier, soit la section User Alias.
| Champ | Description | Obligatoire |
|---|---|---|
| Event name | Nom de l’événement. | Oui |
| Event time | Date et heure sous forme de chaîne de caractères au format ISO 8601 ou yyyy-MM-dd'T'HH:mm:ss:SSSZ. |
Oui |
| App identifier | L’identifiant d’application ou app_id est un paramètre associant l’activité à une application spécifique dans votre espace de travail. Il désigne l’application avec laquelle vous interagissez au sein de l’espace de travail. |
Non |
| Event Properties | Un objet JSON contenant les propriétés personnalisées de l’événement. | Non |
L’action Braze Send Event ne nécessite que la spécification d’un Event Name et d’un Event Time, mais vous devriez inclure autant d’informations que possible dans le champ des propriétés personnalisées. Consultez l’objet événement pour plus de détails.
Les attributs utilisateur peuvent être un objet JSON contenant des champs qui créeront ou mettront à jour un attribut avec le nom et la valeur fournis sur le profil utilisateur spécifié. Les propriétés suivantes sont prises en charge :
| Attribut utilisateur | Description |
|---|---|
| First Name | Prénom de l’utilisateur. |
| Last Name | Nom de famille de l’utilisateur. |
| Phone | Numéro de téléphone de l’utilisateur. |
| Adresse e-mail de l’utilisateur. | |
| Gender | L’une des chaînes de caractères suivantes : “M”, “F”, “O” (autre), “N” (non applicable), “P” (préfère ne pas dire). |
| City | La ville de l’utilisateur. |
| Country | Le pays de l’utilisateur sous forme de chaîne de caractères au format ISO-3166-1 alpha-2. |
| Language | La langue de l’utilisateur sous forme de chaîne de caractères au format ISO-639-1. |
| Date of Birth | La date de naissance de l’utilisateur sous forme de chaîne de caractères au format “YYYY-MM-DD” (par exemple, 1980-12-21). |
| Time Zone | Le nom du fuseau horaire issu de la base de données IANA Time Zone (par exemple, ‘America/New_York’ ou ‘Eastern Time (US & Canada)’). |
Un hash contenant l’un des éléments suivants : id (chaîne de caractères), likes (tableau de chaînes de caractères), num_friends (entier). |
|
Hash contenant l’un des éléments suivants : id (entier), screen_name (chaîne de caractères, identifiant X (anciennement Twitter)), followers_count (entier), friends_count (entier), statuses_count (entier). |
Tous les attributs ajoutés dans la configuration seront envoyés à chaque fois que l’événement est envoyé à Braze, que la valeur de l’attribut ait changé ou non. Lors de la configuration des attributs utilisateur, assurez-vous de comprendre l’impact que cela aura sur votre consommation de points de donnée.
Étape 5 : Créer une règle d’envoi d’événement d’achat
Après avoir installé l’extension, créez une nouvelle règle de transfert d’événements et configurez ses conditions selon vos besoins. Lors de la configuration des actions pour la règle, sélectionnez l’extension Braze, puis sélectionnez Send Purchase Event comme type d’action.
| Champ | Description |
|---|---|
| External user ID | Un UUID ou GUID long, aléatoire et bien distribué. Si vous choisissez une autre méthode pour nommer vos ID utilisateur, ils doivent également être longs, aléatoires et bien distribués. En savoir plus sur la convention de nommage suggérée pour les ID utilisateur. |
| Braze user ID | Identifiant utilisateur Braze. |
| User alias | Un alias sert d’identifiant utilisateur unique alternatif. Utilisez les alias pour identifier les utilisateurs selon des dimensions différentes de votre ID utilisateur principal. L’objet alias utilisateur est composé de deux parties : un alias_name pour l’identifiant lui-même et un alias_label indiquant le type d’alias. Les utilisateurs peuvent avoir plusieurs alias avec des labels différents, mais un seul alias_name par alias_label. |
Pour associer l’événement à un utilisateur, vous devez renseigner soit le champ External User ID, soit le champ Braze User Identifier, soit la section User Alias.
| Champ | Description | Obligatoire |
|---|---|---|
| Product ID | Identifiant de l’achat. (par exemple, nom du produit ou catégorie du produit) | Oui |
| Purchase time | Date et heure sous forme de chaîne de caractères au format ISO 8601 ou yyyy-MM-dd'T'HH:mm:ss:SSSZ. |
Oui |
| Currency | Devise sous forme de chaîne de caractères au format de code alphabétique ISO 4217. | Oui |
| Price | Le prix de l’objet. | Oui |
| Quantity | La quantité achetée. Si non fournie, la valeur par défaut sera 1. La valeur maximale doit être inférieure à 100. | Non |
| App identifier | L’identifiant d’application ou app_id est un paramètre associant l’activité à une application spécifique dans votre espace de travail. Il désigne l’application avec laquelle vous interagissez au sein de l’espace de travail. |
Non |
| Purchase properties | Un objet JSON contenant les propriétés personnalisées de l’achat. | Non |
L’action Send Purchase Event ne nécessite que la spécification d’un Product ID, d’un Purchase Time, d’une Currency et d’un Price, mais vous devriez inclure autant d’informations que possible dans le champ des propriétés d’achat. Consultez l’objet achat pour plus de détails.
Vous pouvez choisir d’envoyer ou non des attributs avec chaque événement dans la vue de configuration.
Les attributs utilisateur peuvent être un objet JSON contenant des champs qui créeront ou mettront à jour un attribut avec le nom et la valeur fournis sur le profil utilisateur spécifié. Les propriétés suivantes sont prises en charge :
| Attribut utilisateur | Description |
|---|---|
| First name | Prénom de l’utilisateur. |
| Last name | Nom de famille de l’utilisateur. |
| Phone | Numéro de téléphone de l’utilisateur. |
| Adresse e-mail de l’utilisateur. | |
| Gender | L’une des chaînes de caractères suivantes : “M”, “F”, “O” (autre), “N” (non applicable), “P” (préfère ne pas dire). |
| City | La ville de l’utilisateur. |
| Country | Le pays de l’utilisateur sous forme de chaîne de caractères au format ISO-3166-1 alpha-2. |
| Language | La langue de l’utilisateur sous forme de chaîne de caractères au format ISO-639-1. |
| Date of birth | La date de naissance de l’utilisateur sous forme de chaîne de caractères au format “YYYY-MM-DD” (par exemple, 1980-12-21). |
| Time zone | Le nom du fuseau horaire issu de la base de données IANA Time Zone (par exemple, ‘America/New_York’ ou ‘Eastern Time (US & Canada)’). |
Un hash contenant l’un des éléments suivants : id (chaîne de caractères), likes (tableau de chaînes de caractères), num_friends (entier). |
|
Hash contenant l’un des éléments suivants : id (entier), screen_name (chaîne de caractères, identifiant X (anciennement Twitter)), followers_count (entier), friends_count (entier), statuses_count (entier). |
Tous les attributs ajoutés dans la configuration seront envoyés à chaque fois que l’événement est envoyé à Braze, que la valeur de l’attribut ait changé ou non. Lors de la configuration des attributs utilisateur, assurez-vous de comprendre l’impact que cela aura sur votre consommation de points de donnée.
Étape 6 : Valider les données dans Braze
Si la collecte d’événements et l’intégration avec Adobe Experience Platform ont réussi, vous verrez les événements dans la console Braze lors de la consultation des profils utilisateur. Plus précisément, les nouvelles données d’événement envoyées à Braze sont reflétées dans la section Purchases ou Custom Events de l’onglet d’aperçu d’un utilisateur donné.