Referenzen, Repositories und Beispiel-Apps
Dies ist eine Liste der Referenzdokumentationen, GitHub-Repositories und Beispiel-Apps, die zu jedem Braze SDK gehören. In der Referenzdokumentation eines SDKs finden Sie die verfügbaren Klassen, Typen, Funktionen und Variablen. Das GitHub-Repository bietet Insights zu den Funktions- und Attribut-Deklarationen, Code-Änderungen und der Versionierung des SDKs. Jedes Repository enthält außerdem vollständig kompilierbare Beispielanwendungen, mit denen Sie die Features von Braze testen oder neben Ihren eigenen Anwendungen implementieren können.
Gespiegelte Repository-README-Inhalte in der Dokumentation finden Sie unter Repository-Leitfäden.
Liste der Ressourcen
Derzeit verfügen einige SDKs noch nicht über eine eigene Referenzdokumentation—wir arbeiten jedoch aktiv daran.
| Plattform | Referenz | Repository | Beispiel-App |
|---|---|---|---|
| Android SDK | Referenzdokumentation | GitHub-Repository | Beispiel-App |
| Swift SDK | Referenzdokumentation | GitHub-Repository | Beispiel-App |
| Internet SDK | Referenzdokumentation | GitHub-Repository | Beispiel-App |
| Javascript SDK | Referenzdokumentation | GitHub-Repository | N/A |
| Cordova SDK | Deklarationsdatei | GitHub-Repository | Beispiel-App |
| Flutter SDK | Referenzdokumentation | GitHub-Repository | Beispiel-App |
| React Native SDK | Referenzdokumentation | GitHub-Repository | Beispiel-App |
| Vega SDK | Referenzdokumentation | GitHub-Repository | N/A |
| Roku SDK | N/A | GitHub-Repository | Beispiel-App |
| Unity SDK | Deklarationsdatei | GitHub-Repository | Beispiel-App |
| .NET MAUI SDK (ehemals Xamarin) | N/A | GitHub-Repository | Beispiel-App |
Erstellen einer Beispiel-App
„Droidboy“ erstellen
Unsere Testanwendung im Android SDK GitHub-Repository heißt Droidboy. Befolgen Sie diese Anweisungen, um eine voll funktionsfähige Kopie neben Ihrem Projekt zu erstellen.
- Erstellen Sie einen neuen Workspace und notieren Sie sich den Braze-API-Bezeichnerschlüssel.
- Kopieren Sie Ihre FCM-Sender-ID und den Braze-API-Bezeichnerschlüssel an die entsprechenden Stellen in
/droidboy/res/values/braze.xml(zwischen die Tags für die Strings mit den Namencom_braze_push_fcm_sender_idbzw.com_braze_api_key). - Kopieren Sie Ihren FCM-Serverschlüssel und Ihre Server-ID in Ihre Workspace-Einstellungen unter Einstellungen verwalten.
- Um die Droidboy-APK zu erstellen, führen Sie
./gradlew assembleim SDK-Verzeichnis aus. Verwenden Sie unter Windowsgradlew.bat. - Um die Droidboy-APK automatisch auf einem Testgerät zu installieren, führen Sie
./gradlew installDebugim SDK-Verzeichnis aus:
„Hello Braze“ erstellen
Die Hello-Braze-Testanwendung zeigt einen minimalen Anwendungsfall des Braze SDK und demonstriert zusätzlich, wie das Braze SDK einfach in ein Gradle-Projekt integriert werden kann.
- Kopieren Sie Ihren API-Bezeichnerschlüssel von der Seite Einstellungen verwalten in Ihre
braze.xml-Datei im Ordnerres/values.
- Um die Beispiel-App auf einem Gerät oder Emulator zu installieren, führen Sie den folgenden Befehl im SDK-Verzeichnis aus:
./gradlew installDebug
Wenn Ihre
ANDROID_HOME-Variable nicht korrekt gesetzt ist oder Sie keinenlocal.properties-Ordner mit einem gültigensdk.dir-Ordner haben, installiert dieses Plugin auch das Basis-SDK für Sie. Weitere Informationen finden Sie im Plugin-Repository.
Weitere Informationen zum Android-SDK-Build-System finden Sie in der GitHub-Repository-README.
Swift-Test-Apps erstellen
Befolgen Sie diese Anweisungen, um unsere Testanwendungen zu erstellen und auszuführen.
- Erstellen Sie einen neuen Workspace und notieren Sie sich den App-Bezeichner-API-Schlüssel und den Endpunkt.
- Wählen Sie basierend auf Ihrer Integrationsmethode (Swift-Paketmanager, CocoaPods, manuell) die entsprechende
xcodeproj-Datei zum Öffnen aus. - Geben Sie Ihren API-Schlüssel und Ihren Endpunkt in das entsprechende Feld in der
Credentials-Datei ein.
Verwenden Sie bei der Qualitätssicherung Ihrer SDK-Integration den SDK-Debugger, um Probleme zu beheben, ohne die ausführliche Protokollierung für Ihre App zu aktivieren.