Skip to content


Configuration initiale du SDK

Cet article de référence explique comment installer le SDK Braze pour tvOS. L’installation du SDK Braze vous fournira des fonctionnalités d’analyse de base.

Le SDK Braze pour tvOS doit être installé ou mis à jour à l’aide de CocoaPods, un gestionnaire de dépendances pour les projets Objective-C et Swift. CocoaPods offre une simplicité supplémentaire pour l’intégration et la mise à jour.

Intégration SDK CocoaPods de tvOS

Étape 1 : Installer CocoaPods

L’installation du SDK via le tvOS CocoaPods permet d’automatiser la majeure partie du processus d’installation. Avant de commencer ce processus, assurez-vous que vous utilisez la version Ruby 2.0.0 ou une version ultérieure.

Exécutez la commande suivante pour démarrer :

1

$ sudo gem install cocoapods

Étape 2 : Construction du Podfile

Maintenant que vous avez installé CocoaPods Ruby Gem, vous devez créer un fichier dans votre répertoire de projet Xcode nommé Podfile.

Ajoutez la ligne suivante à votre Podfile :

1
2
3

target 'YourAppTarget' do
  pod 'Appboy-tvOS-SDK'
end

Nous vous suggérons la version Braze afin que les mises à jour du pod récupèrent automatiquement tout ce qui est plus petit qu’une mise à jour mineure de la version. Cela ressemble à pod 'Appboy-tvOS-SDK' ~> Major.Minor.Build. Si vous souhaitez intégrer automatiquement la dernière version de Braze SDK, même avec des modifications majeures, vous pouvez utiliser pod 'Appboy-tvOS-SDK' dans votre Podfile.

Étape 3 : Installer le SDK Braze

Pour installer le SDK CocoaPods Braze, accédez au répertoire de votre projet d’application Xcode au sein de votre terminal et exécutez la commande suivante :

1

pod install

À ce stade, vous devriez pouvoir ouvrir le nouvel espace de travail du projet Xcode créé par CocoaPods. Assurez-vous d’utiliser cet espace de travail Xcode au lieu de votre projet Xcode.

Étape 4 : Mettre à jour la délégation de votre application

Ajoutez la ligne de code suivante à votre fichier AppDelegate.m :

1

#import <AppboyTVOSKit/AppboyKit.h>

Dans votre fichier AppDelegate.m, ajoutez l’extrait de code suivant au sein de votre méthode application:didFinishLaunchingWithOptions :

1
2
3

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

Enfin, mettez à jour YOUR-API-KEY avec la valeur correcte à partir de votre page Gérer les paramètres.

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

1

import AppboyTVOSKit

Pour plus d’informations sur l’utilisation du code Objective-C dans les projets Swift, consultez la documentation du développeur Apple.

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

1

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

Ensuite, mettez à jour YOUR-API-KEY avec la valeur correcte à partir de votre page Gérer les paramètres.

Notre 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.

Étape 5 : Spécifiez votre endpoint ou cluster de données personnalisé

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

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 Appboy à votre fichier Info.plist. À l’intérieur du dictionnaire Appboy, ajoutez la sous-entrée de chaîne de caractères Endpoint et définissez la valeur sur l’autorité de votre URL d’endpoint personnalisé (par exemple, sdk.iad-01.braze.com, et non https://sdk.iad-01.braze.com).

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 sur l’autorité de votre URL d’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. Notez que lors de la compilation de votre application tvOS et de toute autre bibliothèque tierce, Bitcode doit être activé.

Mettre à jour le SDK Braze par CocoaPods

Pour mettre à jour un CocoaPod, exécutez simplement les commandes suivantes dans votre répertoire de projet :

1

pod update

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.

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-API-KEY"
          inApplication:application
      withLaunchOptions:launchOptions
      withAppboyOptions:appboyOptions];

Dans AppDelegate.swift, au sein de votre méthode application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool, ajoutez la méthode Braze suivante :

1
2
3
4

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

où appboyOptions est un Dictionary de valeurs de configuration de démarrage.

Cette méthode remplacera la méthode d’initialisation startWithApiKey:inApplication:withLaunchOptions: et sera employée avec les paramètres suivants :

  • YOUR-API-KEY : La clé API de votre application se trouve sous Gérer les paramètres dans le 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.

Options d’intégration manuelle

Vous pouvez également intégrer notre SDK tvOS manuellement - il vous suffit de récupérer le Framework depuis notre Dépôt public et d’initialiser Braze comme indiqué dans les sections précédentes.

Identification des utilisateurs et analyse des rapports

Consultez notre documentation iOS pour obtenir des informations sur la définition des ID utilisateurs, la journalisation des événements personnalisés, la définition des attributs clients. Nous vous recommandons également de vous familiariser avec les conventions de dénomination de nos événements.

Github   Modifier cette page sur GitHub
CETTE PAGE A-T-ELLE ÉTÉ UTILE?
New Stuff!