warning:

AppboyKit (également connu sous le nom de SDK Objective-C) n’est plus pris en charge et a été remplacé par Swift SDK. Il ne recevra plus de nouvelles fonctionnalités, de corrections de bugs, de mises à jour de sécurité ou d’assistance technique - cependant, la messagerie et l’analyse continueront à fonctionner normalement. Pour en savoir plus, consultez Présentation du nouveau SDK Braze Swift.

Achever 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 la délégation de votre application

objective-c
swift

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

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

Si vous procédez à une intégration avec le gestionnaire de paquets swift ou à une intégration manuelle statique, utilisez cette ligne à la place :

#import "AppboyKit.h"

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

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

Mettez à jour YOUR-APP-IDENTIFIER-API-KEY avec la valeur correcte à partir de votre page Gérer les paramètres. Consultez notre documentation sur l’API pour savoir où trouver la clé API de votre identifiant d’application.

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

import Appboy_iOS_SDK

Si vous procédez à une intégration avec le gestionnaire de paquets swift ou à une intégration manuelle statique, utilisez cette ligne à la place :

import AppboyKit

Reportez-vous à la Documentation des développeurs Apple pour plus d’informations sur l’utilisation du code Objective-C dans les projets Swift.

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

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

note:

Le singleton sharedInstance sera nul avant que startWithApiKey: ne soit appelé, car il s’agit d’une condition préalable à l’utilisation de toute fonctionnalité de Braze.

warning:

Assurez-vous d’initialiser Braze dans le fil principal de votre application. L’initialisation asynchrone peut entraîner un échec de la fonctionnalité.

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

note:

Notez que depuis décembre 2019, les points de terminaison personnalisés ne sont plus donnés. Si vous disposez d’un endpoint personnalisé préexistant, vous pouvez continuer à l’utiliser. Pour plus de détails, consultez notre liste d’endpoints disponibles.

Configuration des endpoints de compilation (recommandée)

Si vous avez un endpoint personnalisé préexistant :

À partir du SDK Braze pour iOS v3.0.2, vous pouvez définir un endpoint personnalisé à l’aide du fichier Info.plist. Ajouter le dictionnaire Braze à votre fichier Info.plist. À l’intérieur du dictionnaire Braze, ajoutez la sous-entrée de chaîne Endpoint et définissez la valeur à l’autorité de votre URL de endpoint personnalisé (par exemple, sdk.iad-01.braze.com, pas https://sdk.iad-01.braze.com). Notez qu’avant SDK Braze pour iOS v4.0.2, la clé du dictionnaire Appboy doit être utilisée à la place de Braze.

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

Configuration du endpoint d’exécution

Si vous avez un endpoint personnalisé préexistant :

À partir du SDK Braze pour iOS v3.17.0+, vous pouvez remplacer votre endpoint par ABKEndpointKey à l’intérieur du paramètre appboyOptions transmis à startWithApiKey:inApplication:withLaunchOptions:withAppboyOptions:. Définissez la valeur à l’autorité de votre URL d’endpoint personnalisé (par exemple, sdk.iad-01.braze.com, pas 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, l’envoi de messages push et la suite complète des fonctionnalités de Braze.

Personnaliser Braze au démarrage

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

objective-c
swift

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

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

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

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

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

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

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

YOUR-APP-IDENTIFIER-API-KEY – Votre clé API d’identifiant d’application du tableau de bord de Braze.
application – L’application actuelle.
launchOptions – Les options NSDictionary que vous obtenez de application:didFinishLaunchingWithOptions:.
appboyOptions – Un NSDictionary facultatif avec les valeurs de configuration de démarrage de Braze.

Voir Appboy.h pour obtenir la liste des touches de démarrage de Braze.

Valeurs nulles Swift et Appboy.sharedInstance()

Légèrement différent de la pratique courante, le singleton Appboy.sharedInstance() est facultatif. Cela est dû au fait que sharedInstance est nil avant l’appel de startWithApiKey:, et qu’il existe des implémentations non standard et non valides dans lesquelles une initialisation retardée peut être utilisée.

Si vous utilisez startWithApiKey: dans votre délégation didFinishLaunchingWithOptions: avant tout accès à sharedInstance d’Appboy (l’implémentation standard), vous pouvez utiliser des chaînages facultatifs, comme Appboy.sharedInstance()?.changeUser("testUser"), pour éviter des vérifications fastidieuses. Il y aura parité avec une implémentation Objective-C qui a supposé un sharedInstance non nul.

Ressources complémentaires

Une documentation complète sur les classes iOS est disponible pour fournir des conseils supplémentaires sur toutes les méthodes du SDK.

Modifier cette page sur GitHub

New Stuff!