Skip to content


SDK-Ersteinrichtung

Dieser Referenzartikel beschreibt, wie Sie das Braze SDK für tvOS installieren. Durch die Installation des Braze SDK erhalten Sie die grundlegenden Analytics-Funktionen.

Das tvOS Braze SDK sollte mit CocoaPods, einem Abhängigkeitsmanager für Objective-C- und Swift-Projekte, installiert oder aktualisiert werden. CocoaPods bietet zusätzliche Einfachheit bei der Integration und Aktualisierung.

tvOS SDK CocoaPods-Integration

1. Schritt: CocoaPods installieren

Die Installation des SDK über die tvOS CocoaPods automatisiert den Großteil des Installationsprozesses für Sie. Bevor Sie mit diesem Vorgang beginnen, stellen Sie sicher, dass Sie Ruby Version 2.0.0 oder höher verwenden.

Führen Sie als Erstes folgenden Befehl aus:

1

$ sudo gem install cocoapods

2. Schritt: Erstellen der Poddatei

Nachdem Sie nun den CocoaPods Ruby Gem installiert haben, müssen Sie in Ihrem Xcode-Projektverzeichnis eine Datei namens Podfile erstellen.

Fügen Sie die folgende Zeile in Ihr Podfile ein:

1
2
3

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

Wir empfehlen Ihnen, Braze so zu versionieren, dass Pod-Updates automatisch alles erfassen, was kleiner als eine Minor-Versionsaktualisierung ist. Also etwa pod 'Appboy-tvOS-SDK' ~> Major.Minor.Build. Wenn Sie die neueste Version des Braze SDK automatisch integrieren möchten, auch bei größeren Änderungen, können Sie pod 'Appboy-tvOS-SDK' in Ihrem Podfile verwenden.

3. Schritt: Installieren des Braze SDK

Um die Braze SDK CocoaPods zu installieren, navigieren Sie in Ihrem Terminal zum Verzeichnis Ihres Xcode-App-Projekts und führen den folgenden Befehl aus:

1

pod install

Jetzt sollten Sie den von CocoaPods erstellten neuen Xcode-Projektarbeitsbereich öffnen können. Stellen Sie sicher, dass Sie diesen Xcode-Workspace anstelle Ihres Xcode-Projekts verwenden.

4. Schritt: Aktualisieren Ihres App-Delegaten

Fügen Sie die folgende Codezeile in Ihre Datei AppDelegate.m ein:

1

#import <AppboyTVOSKit/AppboyKit.h>

Fügen Sie in Ihrer AppDelegate.m-Datei das folgende Snippet in Ihre Methode application:didFinishLaunchingWithOptions ein:

1
2
3

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

Aktualisieren Sie abschließend YOUR-API-KEY mit dem korrekten Wert auf Ihrer Seite Einstellungen verwalten.

Wenn Sie das Braze SDK mit CocoaPods oder Carthage integrieren, fügen Sie die folgende Codezeile in Ihre AppDelegate.swift-Datei ein:

1

import AppboyTVOSKit

Weitere Informationen zur Verwendung von Objective-C-Code in Swift-Projekten finden Sie in den Apple Developer Docs.

Fügen Sie in AppDelegate.swift folgendes Snippet zu Ihrem application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool hinzu:

1

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

Aktualisieren Sie als Nächstes YOUR-API-KEY auf der Seite Einstellungen verwalten mit dem richtigen Wert.

Unser sharedInstance-Singleton wird nil sein, bevor startWithApiKey: aufgerufen wird, da dies eine Voraussetzung für die Verwendung jeglicher Braze-Funktionen ist.

5. Schritt: Geben Sie Ihren angepassten Endpunkt oder Daten-Cluster an

Ihre Braze-Vertretung sollte Sie bereits über den korrekten Endpunkt informiert haben.

Wenn ein bereits vorhandener angepasster Endpunkt angegeben wird:

  • Ab Braze iOS SDK v3.0.2 können Sie einen angepassten Endpunkt mithilfe der Datei Info.plist festlegen. Fügen Sie das Wörterbuch Appboy zu Ihrer Datei Info.plist hinzu. Fügen Sie im Appboy-Dictionary den String-Untereintrag Endpoint hinzu und setzen Sie den Wert auf die Autorität Ihrer angepassten Endpunkt-URLs (z. B. sdk.iad-01.braze.com, nicht https://sdk.iad-01.braze.com).

Laufzeit-Endpunkt-Konfiguration

Wenn ein bereits vorhandener angepasster Endpunkt angegeben wird:

  • Ab Braze iOS SDK v3.17.0+ können Sie Ihren Endpunkt über den ABKEndpointKey innerhalb des appboyOptions-Parameters, der an startWithApiKey:inApplication:withLaunchOptions:withAppboyOptions: übergeben wird, überschreiben. Setzen Sie den Wert auf Ihre angepasste Endpunkt-URL-Autorität (z. B. sdk.iad-01.braze.com, nicht https://sdk.iad-01.braze.com).

SDK-Integration abgeschlossen

Braze sollte nun Daten von Ihrer Anwendung erfassen und die grundlegende Integration sollte abgeschlossen sein. Beachten Sie, dass Bitcode bei der Kompilierung Ihrer tvOS-App und aller anderen Bibliotheken von Drittanbietern aktiviert sein muss.

Aktualisieren des Braze SDK über CocoaPods

Um einen CocoaPod zu aktualisieren, führen Sie einfach die folgenden Befehle in Ihrem Projektverzeichnis aus:

1

pod update

Anpassen von Braze beim Start

Wenn Sie Braze beim Start anpassen möchten, können Sie stattdessen die Braze-Initialisierungsmethode startWithApiKey:inApplication:withLaunchOptions:withAppboyOptions verwenden und ein optionales NSDictionary von Braze-Startschlüsseln übergeben.

Fügen Sie in Ihrer AppDelegate.m-Datei innerhalb Ihrer application:didFinishLaunchingWithOptions-Methode die folgende Braze-Methode hinzu:

1
2
3
4

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

Fügen Sie in AppDelegate.swift innerhalb Ihrer Methode application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool die folgende Braze-Methode hinzu:

1
2
3
4

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

wobei appboyOptions ein Dictionary der Werte der Startkonfiguration ist.

Diese Methode ersetzt die Initialisierungsmethode startWithApiKey:inApplication:withLaunchOptions: und wird mit den folgenden Parametern aufgerufen:

  • YOUR-API-KEY: Den API-Schlüssel Ihrer Anwendung finden Sie unter Einstellungen verwalten im Braze-Dashboard.
  • application: Die aktuelle App.
  • launchOptions: Das Optionen-NSDictionary, das Sie von application:didFinishLaunchingWithOptions: erhalten.
  • appboyOptions: Ein optionales NSDictionary mit Werten für die Startkonfiguration von Braze.

Siehe Appboy.h für eine Liste der Braze-Startschlüssel.

Appboy.sharedInstance() und Swift-Nullbarkeit

Abweichend von der üblichen Praxis ist das Singleton Appboy.sharedInstance() optional. Das liegt daran, dass sharedInstance nil ist, bevor startWithApiKey: aufgerufen wird, und es gibt einige nicht standardmäßige, aber nicht ungültige Implementierungen, in denen eine verzögerte Initialisierung verwendet werden kann.

Wenn Sie startWithApiKey: in Ihrem didFinishLaunchingWithOptions:-Delegaten aufrufen, bevor Sie auf sharedInstance von Appboy (Standardimplementierung) zugreifen, können Sie eine optionale Verkettung wie Appboy.sharedInstance()?.changeUser("testUser") verwenden, um lästige Überprüfungen zu vermeiden. Dies ist vergleichbar mit einer Objective-C-Implementierung, die von einem Nicht-Null-Wert sharedInstance ausgeht.

Optionen für die manuelle Integration

Sie können unser tvOS SDK auch manuell integrieren – holen Sie sich einfach das Framework aus unserem Public Repository und initialisieren Sie Braze wie in den vorangegangenen Abschnitten beschrieben.

Nutzer:innen identifizieren und Analytics-Berichte

In unserer iOS-Dokumentation finden Sie Informationen zum Festlegen von Nutzer-IDs, zum Protokollieren angepasster Events und zum Festlegen von Nutzer:innen-Attributen. Wir empfehlen Ihnen auch, sich mit unseren Namenskonventionen für Events vertraut zu machen.
New Stuff!