Skip to content


Die Integration abschließen

Bevor Sie diese Schritte ausführen, vergewissern Sie sich bitte, dass das SDK mit Carthage, CocoaPods, dem Swift-Paketmanager oder einer manuellen Integration integriert wurde.

1. Schritt: Aktualisieren Sie Ihren App-Delegierten

Wenn Sie das Braze SDK mit CocoaPods, Carthage oder einer dynamischen manuellen Integration integrieren, fügen Sie die folgende Codezeile in die Datei AppDelegate.m ein:

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

Wenn Sie die Integration mit dem Swift-Paketmanager oder einer statischen manuellen Integration vornehmen, verwenden Sie stattdessen diese Zeile:

1
#import "AppboyKit.h"

Fügen Sie als Nächstes in der Datei AppDelegate.m das folgende Snippet in die Methode application:didFinishLaunchingWithOptions: ein:

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

Aktualisieren Sie YOUR-APP-IDENTIFIER-API-KEY mit dem richtigen Wert auf Ihrer Seite Einstellungen verwalten. In unserer API-Dokumentation finden Sie weitere Informationen darüber, wo Sie den API-Schlüssel für Ihre App-Kennung finden.

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

1
import Appboy_iOS_SDK

Wenn Sie die Integration mit dem Swift-Paketmanager oder einer statischen manuellen Integration vornehmen, verwenden Sie stattdessen diese Zeile:

1
import AppboyKit

Weitere Informationen zur Verwendung von Objective-C-Code in Swift-Projekten finden Sie in der Apple-Entwicklerdokumentation.

Fügen Sie als Nächstes in AppDelegate.swift das folgende Snippet zu application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool hinzu:

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

Aktualisieren Sie YOUR-APP-IDENTIFIER-API-KEY mit dem richtigen Wert auf Ihrer Seite Einstellungen verwalten. In unserer API-Dokumentation finden Sie weitere Informationen darüber, wo Sie den API-Schlüssel für Ihre App-Kennung finden.

2. Schritt: Legen Sie Ihren Daten-Cluster fest

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 Braze zu Ihrer Datei Info.plist hinzu. Fügen Sie im Wörterbuch Braze den String-Untereintrag Endpoint hinzu und legen Sie den Wert auf die Autorität der URL des angepassten Endpunkts fest (z. B. sdk.iad-01.braze.com, nicht https://sdk.iad-01.braze.com). Beachten Sie, dass vor Braze iOS SDK v4.0.2 der Wörterbuchschlüssel Appboy anstelle von Braze verwendet werden muss.

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

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. Legen Sie den Wert auf die Autorität der URL des angepassten Endpunkts fest (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. Lesen Sie die folgenden Artikel, um das Tracking angepasster Events, Push-Nachrichten und die gesamte Suite der Braze-Features zu aktivieren.

Braze beim Start anpassen

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 Datei AppDelegate.m innerhalb der Methode application:didFinishLaunchingWithOptions: die folgende Braze-Methode hinzu:

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

Beachten Sie, dass diese Methode die Initialisierungsmethode startWithApiKey:inApplication:withLaunchOptions: ersetzen würde.

Fügen Sie in AppDelegate.swift innerhalb der Methode application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool die folgende Braze-Methode hinzu, wobei appboyOptions ein Dictionary der Startkonfigurationswerte ist:

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

Beachten Sie, dass diese Methode die Initialisierungsmethode startWithApiKey:inApplication:withLaunchOptions: ersetzen würde.

Diese Methode wird mit den folgenden Parametern aufgerufen:

  • YOUR-APP-IDENTIFIER-API-KEY – Der App-Bezeichner-API-Schlüssel aus dem Braze-Dashboard.
  • application – Die aktuelle App.
  • launchOptions – Das Optionen-NSDictionary, das Sie aus 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 für sharedInstance ausgeht.

Zusätzliche Ressourcen

Die vollständige Dokumentation der iOS-Klassen ist verfügbar, um zusätzliche Anleitungen zu allen SDK-Methoden zu liefern.

New Stuff!