Skip to content

Références, dépôts et exemples d’applications

Il s’agit d’une liste de documentation de référence, de dépôts GitHub et d’exemples d’applications appartenant à chaque SDK Braze. La documentation de référence d’un SDK détaille les classes, types, fonctions et variables disponibles. Le dépôt GitHub fournit quant à lui des informations sur les déclarations de fonctions et d’attributs, les modifications de code et le versionnage du SDK. Chaque dépôt comprend également des exemples d’applications prêtes à compiler, que vous pouvez utiliser pour tester les fonctionnalités de Braze ou implémenter en parallèle de vos propres applications.

Pour le contenu des fichiers README des dépôts dans la documentation, consultez les guides des dépôts.

Liste des ressources

Plateforme Référence Dépôt Application exemple
SDK Android Documentation de référence Dépôt GitHub Application exemple
SDK Swift Documentation de référence Dépôt GitHub Application exemple
SDK Web Documentation de référence Dépôt GitHub Application exemple
SDK Javascript Documentation de référence Dépôt GitHub N/A
SDK Cordova Fichier de déclaration Dépôt GitHub Application exemple
SDK Flutter Documentation de référence Dépôt GitHub Application exemple
SDK React Native Documentation de référence Dépôt GitHub Application exemple
SDK Vega Documentation de référence Dépôt GitHub N/A
SDK Roku N/A Dépôt GitHub Application exemple
SDK Unity Fichier de déclaration Dépôt GitHub Application exemple
SDK .NET MAUI (anciennement Xamarin) N/A Dépôt GitHub Application exemple

Création d’une application d’exemple

Création de « Droidboy »

Notre application de test dans le dépôt GitHub du SDK Android s’appelle Droidboy. Suivez ces instructions pour en créer une copie entièrement fonctionnelle aux côtés de votre projet.

  1. Créez un nouvel espace de travail et notez la clé d’identification API Braze.

  2. Copiez votre ID d’expéditeur FCM et votre clé d’identification API Braze aux emplacements appropriés dans /droidboy/res/values/braze.xml (entre les balises des chaînes de caractères nommées com_braze_push_fcm_sender_id et com_braze_api_key, respectivement).

  3. Copiez votre clé de serveur FCM et votre ID de serveur dans les paramètres de votre espace de travail sous Gérer les paramètres.

  4. Pour assembler l’APK Droidboy, exécutez ./gradlew assemble dans le répertoire du SDK. Utilisez gradlew.bat sous Windows.

  5. Pour installer automatiquement l’APK Droidboy sur un appareil de test, exécutez ./gradlew installDebug dans le répertoire du SDK :

Création de « Hello Braze »

L’application de test Hello Braze présente un cas d’usage minimal du SDK Braze et montre également comment intégrer facilement le SDK Braze dans un projet Gradle.

  1. Copiez votre clé d’identification API depuis la page Gérer les paramètres dans votre fichier braze.xml situé dans le dossier res/values. Capture d'écran relative à la création de « Hello Braze ».

  2. Pour installer l’application d’exemple sur un appareil ou un émulateur, exécutez la commande suivante dans le répertoire du SDK : 
    1

    ./gradlew installDebug

    Si votre variable ANDROID_HOME n’est pas correctement configurée ou si vous ne disposez pas d’un dossier local.properties avec un dossier sdk.dir valide, ce plugin installera également le SDK de base pour vous. Consultez le dépôt du plugin pour plus d’informations.

Pour en savoir plus sur le système de compilation du SDK Android, consultez le README du dépôt GitHub.

Création des applications de test Swift

Suivez ces instructions pour créer et exécuter nos applications de test.

  1. Créez un nouvel espace de travail et notez la clé API d’identification de l’application ainsi que l’endpoint.
  2. En fonction de votre méthode d’intégration (gestionnaire de paquets Swift, CocoaPods, manuelle), sélectionnez le fichier xcodeproj approprié à ouvrir.
  3. Saisissez votre clé API et votre endpoint dans le champ approprié du fichier Credentials.
New Stuff!