Skip to content


Terminer l’intégration

Avant de suivre ces étapes, assurez-vous d’avoir intégré le SDK en utilisant Carthage, CocoaPods, le gestionnaire de paquets Swift ou une intégration manuelle.

Étape 1 : Mettre à jour votre app delegate

Si vous intégrez le SDK Braze avec CocoaPods, Carthage ou avec une intégration manuelle dynamique, ajoutez la ligne de code suivante à votre fichier AppDelegate.m :

1

#import "Appboy-iOS-SDK/AppboyKit.h"

Si vous intégrez avec le gestionnaire de paquets Swift ou avec une intégration manuelle statique, utilisez plutôt cette ligne :

1

#import "AppboyKit.h"

Ensuite, dans votre fichier AppDelegate.m, ajoutez l’extrait de code suivant dans votre méthode application:didFinishLaunchingWithOptions: :

1
2
3

[Appboy startWithApiKey:@"YOUR-APP-IDENTIFIER-API-KEY"
          inApplication:application
      withLaunchOptions:launchOptions];

Remplacez YOUR-APP-IDENTIFIER-API-KEY par la valeur correcte depuis votre page Gérer les paramètres. Consultez notre documentation API pour plus d’informations sur l’emplacement de votre clé API d’identifiant d’application.

Si vous intégrez le SDK Braze avec CocoaPods, Carthage ou avec une intégration manuelle dynamique, ajoutez la ligne de code suivante à votre fichier AppDelegate.swift :

1

import Appboy_iOS_SDK

Si vous intégrez avec le gestionnaire de paquets Swift ou avec une intégration manuelle statique, utilisez plutôt cette ligne :

1

import AppboyKit

Consultez la documentation développeur Apple pour plus d’informations sur l’utilisation de code Objective-C dans des projets Swift.

Ensuite, dans AppDelegate.swift, ajoutez l’extrait de code suivant à votre application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool :

1

Appboy.start(withApiKey: "YOUR-APP-IDENTIFIER-API-KEY", in:application, withLaunchOptions:launchOptions)

Remplacez YOUR-APP-IDENTIFIER-API-KEY par la valeur correcte depuis votre page Gérer les paramètres. Consultez notre documentation API pour plus d’informations sur l’emplacement de votre clé API d’identifiant d’application.

Étape 2 : Spécifier votre cluster de données

Si un endpoint personnalisé préexistant vous a été fourni :

  • À partir de la version 3.0.2 du SDK iOS de Braze, vous pouvez définir un endpoint personnalisé à l’aide du fichier Info.plist. Ajoutez le dictionnaire Braze à votre fichier Info.plist. À l’intérieur du dictionnaire Braze, ajoutez la sous-entrée de type chaîne de caractères Endpoint et définissez sa valeur sur l’autorité de l’URL de votre endpoint personnalisé (par exemple, sdk.iad-01.braze.com, et non https://sdk.iad-01.braze.com). Notez qu’avant la version 4.0.2 du SDK iOS de Braze, la clé de dictionnaire Appboy doit être utilisée à la place de Braze.

Votre conseiller Braze devrait déjà vous avoir indiqué l’endpoint correct.

Configuration de l’endpoint à l’exécution

Si un endpoint personnalisé préexistant vous a été fourni :

  • À partir de la version 3.17.0 et ultérieures du SDK iOS de Braze, vous pouvez remplacer votre endpoint via ABKEndpointKey dans le paramètre appboyOptions transmis à startWithApiKey:inApplication:withLaunchOptions:withAppboyOptions:. Définissez la valeur sur l’autorité de l’URL de votre endpoint personnalisé (par exemple, sdk.iad-01.braze.com, et non https://sdk.iad-01.braze.com).

Intégration SDK terminée

Braze devrait maintenant collecter des données depuis votre application, et votre intégration de base devrait être terminée. Consultez les articles suivants pour activer le suivi des événements personnalisés, les notifications push et la suite complète des fonctionnalités de Braze.

Personnalisation de Braze au démarrage

Si vous souhaitez personnaliser Braze au démarrage, vous pouvez utiliser la méthode d’initialisation de Braze startWithApiKey:inApplication:withLaunchOptions:withAppboyOptions: et transmettre un NSDictionary optionnel de clés de démarrage Braze.

Dans votre fichier AppDelegate.m, au sein de votre méthode application:didFinishLaunchingWithOptions:, ajoutez la méthode Braze suivante :

1
2
3
4

[Appboy startWithApiKey:@"YOUR-APP-IDENTIFIER-API-KEY"
          inApplication:application
      withLaunchOptions:launchOptions
      withAppboyOptions:appboyOptions];

Notez que cette méthode remplacerait la méthode d’initialisation startWithApiKey:inApplication:withLaunchOptions:.

Dans AppDelegate.swift, au sein de votre méthode application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool, ajoutez la méthode Braze suivante où appboyOptions est un Dictionary de valeurs de configuration de démarrage :

1
2
3
4

Appboy.start(withApiKey: "YOUR-APP-IDENTIFIER-API-KEY",
                 in:application,
                 withLaunchOptions:launchOptions,
                 withAppboyOptions:appboyOptions)

Notez que cette méthode remplacerait la méthode d’initialisation startWithApiKey:inApplication:withLaunchOptions:.

Cette méthode est appelée avec les paramètres suivants :

  • YOUR-APP-IDENTIFIER-API-KEY – Votre clé API d’identifiant d’application depuis le tableau de bord de Braze.
  • application – L’application actuelle.
  • launchOptions – Le NSDictionary d’options que vous obtenez depuis application:didFinishLaunchingWithOptions:.
  • appboyOptions – Un NSDictionary optionnel contenant les valeurs de configuration de démarrage pour Braze.

Consultez Appboy.h pour obtenir la liste des clés de démarrage de Braze.

Appboy.sharedInstance() et la nullabilité en Swift

Contrairement à la pratique courante, le singleton Appboy.sharedInstance() est optionnel. Cela s’explique par le fait que sharedInstance est nil avant l’appel de startWithApiKey:, et qu’il existe des implémentations non standard mais valides dans lesquelles une initialisation différée peut être utilisée.

Si vous appelez startWithApiKey: dans votre délégué didFinishLaunchingWithOptions: avant tout accès au sharedInstance d’Appboy (l’implémentation standard), vous pouvez utiliser le chaînage optionnel, comme Appboy.sharedInstance()?.changeUser("testUser"), pour éviter des vérifications fastidieuses. Le comportement sera identique à celui d’une implémentation en Objective-C qui suppose un sharedInstance non nul.

Ressources supplémentaires

La documentation complète des classes iOS est disponible pour fournir des informations supplémentaires sur les méthodes du SDK.
New Stuff!