Guide du dépôt du SDK React Native

À propos du SDK React Native de Braze

Le SDK React Native de Braze connecte vos applications iOS et Android à Braze : profils utilisateur, surfaces de communication, analyses et feature flags. Il encapsule les SDK natifs Braze Swift SDK et Braze Android SDK derrière une API JavaScript.

L’initialisation est pilotée par JavaScript : vous configurez les paramètres natifs (notifications push, journalisation, délégués) dans les ressources Android et le fichier AppDelegate d’iOS, puis vous appelez Braze.initialize(apiKey, endpoint) depuis JavaScript pour démarrer le SDK. Cela vous donne un contrôle total sur le moment où le SDK s’initialise et avec quelles informations d’identification. Après l’initialisation, appelez les autres méthodes du SDK (par exemple changeUser, logCustomEvent) selon vos besoins.

Ce que vous pouvez faire

• Gestion des utilisateurs : identifier les utilisateurs, définir les champs de profil, les attributs personnalisés, les alias et les groupes d’abonnement
• Messages in-app : interface Braze par défaut ou gestion personnalisée via des abonnements et des API de journalisation
• Content Cards : flux par défaut, ou récupération des cartes pour créer votre propre interface
• Bannières : bannières HTML basées sur des emplacements, y compris BrazeBannerView
• Notifications push : demandes d’autorisation, enregistrement des jetons, écouteurs de payload (voir Configuration native pour les notes spécifiques à chaque plateforme)
• Feature flags : actualisation, lecture des propriétés, journalisation des impressions
• Analyses : événements personnalisés, achats, envoi immédiat des données
• Contrôles du SDK : activer/désactiver le SDK, effacer les données locales, signatures d’authentification du SDK

Conditions préalables

• Compte Braze avec clé API d’application et endpoint SDK
• Environnement de développement React Native (configuration de l’environnement React Native)
• iOS : Xcode, CocoaPods (cd ios && pod install)
• Android : Android Studio / Gradle ; plugin Kotlin Gradle tel que requis par votre modèle React Native
• Notifications push (si utilisées) : configuration FCM (Android) et APNs (iOS) selon la documentation sur les notifications push

Pour localiser les identifiants dans le tableau de bord, consultez l’aperçu de l’intégration.

Installation

1
2
3

npm install @braze/react-native-sdk
# or:
# yarn add @braze/react-native-sdk

Démarrage rapide

Cette section présente la configuration minimale requise pour initialiser le SDK React Native de Braze.

1. Installez le package npm (voir Installation).
2. Effectuez la configuration native pour Android et iOS (configuration, permissions, notifications push si nécessaire).
3. Initialisez le SDK depuis JavaScript et commencez à l’utiliser :

1
2
3
4
5
6
7
8
9

import Braze from "@braze/react-native-sdk";

// Initialize the SDK — call early in your app lifecycle (e.g. in a useEffect).
// The API key and endpoint are passed from JavaScript; native configuration
// (push, logging, etc.) is applied automatically from your native setup.
Braze.initialize("<YOUR_API_KEY>", "<YOUR_SDK_ENDPOINT>");

Braze.changeUser("user-123");
Braze.logCustomEvent("button_clicked", { screen: "home" });

Les typages TypeScript sont inclus dans le package (src/index.d.ts sur GitHub).

Appeler Braze.initialize à nouveau avec des identifiants différents détruit l’instance en cours et en crée une nouvelle, permettant la réinitialisation en cours de session.

Configuration native

Source de référence : Les écrans de configuration étape par étape, les modifications Gradle/CocoaPods et la liste complète des clés XML Android sont disponibles dans le guide développeur React Native de Braze. Les extraits suivants sont des exemples minimaux.

Android

• Ajoutez le plugin Kotlin Gradle dans votre fichier racine build.gradle si votre modèle ne l’inclut pas déjà (les versions dépendent de votre version de React Native).
• Ajoutez un fichier de ressources braze.xml dans res/values avec votre configuration. Activez l’initialisation différée afin que le SDK attende l’appel de Braze.initialize() depuis JavaScript avant de démarrer. Les autres valeurs de configuration (notifications push, délai d’expiration de session, etc.) sont toujours lues depuis ce fichier et appliquées au moment de l’initialisation.
• Assurez-vous que les permissions de base telles que INTERNET et ACCESS_NETWORK_STATE sont présentes dans AndroidManifest.xml.
• Pour les notifications push, complétez l’intégration FCM et les indicateurs d’ID d’expéditeur / d’enregistrement spécifiques à Braze décrits dans la documentation.

1
2
3
4
5
6
7
8
9
10

<?xml version="1.0" encoding="utf-8"?>
<resources>
  <!-- Enable delayed initialization so the SDK starts when
       Braze.initialize() is called from JavaScript. -->
  <bool name="com_braze_enable_delayed_initialization">true</bool>

  <!-- Additional native configuration (applied at initialization time) -->
  <bool name="com_braze_firebase_cloud_messaging_registration_enabled">true</bool>
  <string translatable="false" name="com_braze_firebase_cloud_messaging_sender_id">YOUR_SENDER_ID</string>
</resources>

Remarque

** La clé API et l’endpoint ne sont plus définis dans braze.xml — ils sont transmis depuis JavaScript via Braze.initialize(apiKey, endpoint).

iOS

1

cd ios && pod install

Utilisez BrazeReactInitializer.configure dans votre AppDelegate pour enregistrer la configuration native. Les closures que vous fournissez sont stockées et appliquées ultérieurement lorsque Braze.initialize(apiKey, endpoint) est appelé depuis JavaScript.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

import BrazeKit
import braze_react_native_sdk

@main
class AppDelegate: UIResponder, UIApplicationDelegate {
  static var braze: Braze? = nil

  func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil
  ) -> Bool {
    // Register native configuration for when JS calls Braze.initialize().
    BrazeReactInitializer.configure { config in
      config.logger.level = .info
      config.push.automation = true
    } postInitialization: { braze in
      AppDelegate.braze = braze
    }

    // ... React Native setup
    return true
  }
}

• Closure configure : reçoit un objet Braze.Configuration et vous permet de définir les propriétés de configuration native (journalisation, notifications push, sessions, etc.). La clé API et l’endpoint sont fournis depuis JavaScript — vous ne les définissez pas ici.
• Closure postInitialization (optionnelle) : reçoit l’instance Braze active après sa création, pour les configurations qui nécessitent l’instance (par exemple, stocker une référence, définir des délégués).

Remarque

** BrazeReactInitializer.configure est une API conçue d’abord pour Swift qui remplace la méthode dépréciée BrazeReactBridge.initBraze(_:). Elle résout également un problème de résolution de type Swift avec Braze.Configuration dans le bridge Objective-C.

Référence de configuration

Dans React Native, la configuration est native : Android lit res/values/braze.xml, et iOS utilise des closures enregistrées via BrazeReactInitializer.configure. Les deux sont appliquées lorsque Braze.initialize(apiKey, endpoint) est appelé depuis JavaScript.

Android (braze.xml)

Les valeurs par défaut sont définies en XML ; BrazeConfig.Builder peut les remplacer au démarrage. La liste complète des clés et types se trouve dans le guide d’intégration du SDK Android et dans BrazeConfigurationProvider (chaque propriété Kotlin correspond à des ressources com_braze_* documentées).

Entrées couramment utilisées :

iOS (Braze.Configuration)

Définissez les propriétés de configuration native dans la closure configure transmise à BrazeReactInitializer.configure. La closure reçoit une instance Braze.Configuration — la clé API et l’endpoint sont définis automatiquement à partir de l’appel JavaScript Braze.initialize. Détails complets : Braze.Configuration et les types imbriqués api, push, logger, location.

Le pont React Native définit les métadonnées api.sdkFlavor / SDK spécifiques à React lors de l’initialisation ; ne les remplacez pas, sauf instruction contraire de la documentation Braze.

API JavaScript / TypeScript

L’export par défaut du package est la classe Braze avec des méthodes statiques (par exemple Braze.changeUser, Braze.logPurchase). Les constantes telles que Braze.Events, Braze.Genders et Braze.NotificationSubscriptionTypes sont rattachées au même export.

Fonctionnalités principales

Gestion des utilisateurs

1
2
3
4
5
6
7

import Braze from "@braze/react-native-sdk";

Braze.changeUser("user-123");
Braze.setEmail("[email protected]");
Braze.setCustomUserAttribute("plan", "premium");
Braze.addAlias("external_id", "marketing_id");
Braze.addToSubscriptionGroup("NEWSLETTER_GROUP_UUID");

Authentification SDK optionnelle : transmettez une signature en deuxième argument de changeUser, ou appelez Braze.setSdkAuthenticationSignature(signature) lorsque cette option est activée dans le tableau de bord.

Messages in-app

• Avec l’interface utilisateur Braze par défaut, suivez la documentation des messages in-app ; vous n’avez généralement pas besoin d’appeler subscribeToInAppMessage uniquement pour afficher l’interface par défaut.
• Pour un traitement personnalisé, abonnez-vous avec useBrazeUI: false, puis enregistrez les impressions et les clics selon vos besoins :

1
2
3
4
5

Braze.subscribeToInAppMessage(false, (event) => {
  const msg = event.inAppMessage;
  // Render your own UI from msg.message, msg.buttons, etc.
  Braze.logInAppMessageImpression(msg);
});

Content Cards

1
2
3
4
5
6

const cards = await Braze.getCachedContentCards();
Braze.requestContentCardsRefresh();
Braze.launchContentCards(); // default Braze UI

Braze.logContentCardImpression(cardId);
Braze.logContentCardClicked(cardId);

Écoutez les mises à jour avec Braze.addListener(Braze.Events.CONTENT_CARDS_UPDATED, ...).

Bannières

1
2
3
4
5
6
7

import Braze from "@braze/react-native-sdk";

Braze.requestBannersRefresh(["homepage_banner"]);
const banner = await Braze.getBanner("homepage_banner");

// Or use the native Banner view:
// <Braze.BrazeBannerView placementId="homepage_banner" />

Notifications push

1
2
3
4
5
6
7

Braze.requestPushPermission({
  alert: true,
  badge: true,
  sound: true,
});
// Token registration is usually handled natively; see docs for your setup.
Braze.registerPushToken(token);

• getInitialPushPayload : à utiliser lorsque l’application s’ouvre depuis une notification afin d’éviter les conditions de concurrence avec Linking de RN ; nécessite des hooks natifs (BrazeReactUtils sur iOS, BrazeReactUtils.populateInitialPushPayloadFromIntent sur Android), comme décrit dans les commentaires de la documentation TypeScript et l’application exemple.
• Braze.addListener(Braze.Events.PUSH_NOTIFICATION_EVENT, ...) est réservé à Android selon les typages publics.

Feature flags

1
2
3
4
5
6

const flag = await Braze.getFeatureFlag("new_checkout");
if (flag?.enabled) {
  const rollout = flag.getNumberProperty("rollout_percentage") ?? 0;
}
Braze.refreshFeatureFlags();
Braze.logFeatureFlagImpression("new_checkout");

Analyses et achats

1
2
3

Braze.logCustomEvent("purchase_completed", { sku: "sku-1" });
Braze.logPurchase("sku-1", "29.99", "USD", 1, { source: "cart" });
Braze.requestImmediateDataFlush();

Remarque : logPurchase accepte le prix sous forme de chaîne de caractères (voir les typages).

Gestion des données et état du SDK

changeUser indique uniquement à Braze quel identifiant utilisateur doit être associé aux nouvelles activités. Il ne supprime pas les données SDK mises en cache sur l’appareil. Il n’existe pas d’API de « déconnexion » distincte : si vous avez besoin d’une déconnexion classique (effacer l’état local de Braze afin que le profil, les messages et les jetons mis en cache de l’utilisateur précédent ne soient plus présents sur cette installation), vous utilisez généralement wipeData(). Il s’agit d’une réinitialisation locale complète.

1
2
3

Braze.wipeData();
Braze.disableSDK();
Braze.enableSDK();

wipeData() — Efface les données locales de Braze pour cette installation (état utilisateur/session/cartes mis en cache, association du jeton push, etc.). À utiliser pour un comportement de type déconnexion lorsque vous ne devez pas laisser l’état Braze de l’utilisateur précédent sur l’appareil, ainsi que pour les scénarios « supprimer mes données sur cet appareil », les réinitialisations d’assurance qualité sans réinstallation, ou les flux stricts de confidentialité. changeUser seul n’effectue pas ce nettoyage — il définit uniquement quel identifiant utilisateur reçoit les nouveaux événements. Sur iOS, le comportement peut différer d’Android (par exemple, l’interaction avec l’état SDK désactivé) ; consultez la documentation native de Braze si vous utilisez cette fonctionnalité en production.

disableSDK() — Arrête le fonctionnement du SDK (aucune collecte ni transfert tel que configuré). À utiliser pour les boutons d’opt-out utilisateur, les modes restreints (conformité, paramètres pour les enfants), ou le débogage sans supprimer la dépendance.

enableSDK() — Réactive le SDK après un appel à disableSDK(). Sur iOS, la réactivation peut ne pas prendre effet avant le prochain lancement de l’application ; vérifiez dans la documentation Braze Swift/iOS avant de compter sur une réactivation immédiate.

Événements

Abonnez-vous avec Braze.addListener(event, callback). L’appel renvoie un objet d’abonnement ; appelez .remove() sur celui-ci pour arrêter l’écoute.

Configuration d’un écouteur :

1
2
3
4
5
6
7
8

import Braze from "@braze/react-native-sdk";

const subscription = Braze.addListener(
  Braze.Events.CONTENT_CARDS_UPDATED,
  (update) => {
    console.log("Content cards:", update.cards);
  }
);

Suppression de l’écouteur :

1

subscription.remove();

Dans un composant React, stockez l’abonnement et appelez .remove() dans votre nettoyage (par exemple le retour d’un useEffect) :

1
2
3
4
5
6

useEffect(() => {
  const sub = Braze.addListener(Braze.Events.CONTENT_CARDS_UPDATED, (update) => {
    setCards(update.cards);
  });
  return () => sub.remove();
}, []);

Notes d’intégration

• Expo : utilisez le plugin Braze Expo pour éviter autant que possible le câblage natif manuel.
• New Architecture / Turbo Modules : pris en charge dans les versions récentes du plugin ; suivez le guide développeur et les exemples de configuration AppDelegate / Gradle si vous effectuez la migration.
• Confidentialité (iOS) : des méthodes telles que updateTrackingPropertyAllowList permettent de gérer la configuration liée au manifeste de confidentialité ; consultez le manifeste de confidentialité Swift.

- Jest : simulez les modules natifs react-native ou le module Braze Turbo (consultez __tests__/jest.setup.js dans ce dépôt pour des exemples de configuration).

Prise en charge des versions

Remarque

Ce SDK a été testé avec la version 0.85.3 de React Native.

Le tableau suivant répertorie les versions de React Native prises en charge par version du plugin Braze.

Respectez également les exigences des SDK natifs :

• Informations sur les versions du SDK Android
• Informations sur les versions du SDK Swift

Plugin Braze Expo

Pour les workflows gérés par Expo, consultez le dépôt du plugin Braze Expo.

Application exemple

BrazeProject dans ce dépôt est un exemple complet (gestion des utilisateurs, Content Cards, feature flags, bannières, etc.).

1
2
3

cd BrazeProject/
yarn install
npx react-native start

iOS (depuis BrazeProject) :

1
2

cd ios && pod install && cd ..
npx react-native run-ios

Utilisez RCT_NEW_ARCH_ENABLED=0 pod install si vous avez besoin de l’architecture legacy.

Android (depuis BrazeProject) :

1

npx react-native run-android

Débogage et résolution des problèmes

Activez la journalisation Braze dans la configuration native pendant le développement afin que le SDK écrive dans la console système (Xcode / Android Logcat). Cela permet de vérifier l’initialisation, les changements d’utilisateur et la distribution des événements.

• iOS — Dans la closure configure passée à BrazeReactInitializer.configure, définissez config.logger.level = .debug (ou .info). Réduisez le niveau ou désactivez la journalisation en production pour que les logs ne soient pas visibles par les utilisateurs.
• Android — Utilisez la ressource com_braze_logger_initial_log_level dans braze.xml ou définissez l’équivalent sur BrazeConfig.Builder (voir BrazeConfigurationProvider). Utilisez un niveau non verbeux ou supprimez le remplacement avant la mise en production.

Pour une résolution des problèmes plus approfondie (réseau, session ou comportement des campagnes), consultez le guide développeur Braze React Native et la documentation des SDK natifs (Swift · Android).

Ressources supplémentaires

• Guide développeur Braze — React Native
• Notifications push — React Native
• Dépôt GitHub
• Package npm

Contact

Pour toute question, contactez le support technique Braze pour obtenir de l’aide.

Pour les détails du dépôt et les exemples de projets, consultez https://github.com/braze-inc/braze-react-native-sdk.