リファレンス、リポジトリ、サンプルアプリ
各SDKに属するリファレンスドキュメント、GitHubリポジトリ、サンプルアプリの一覧である。SDKのリファレンス・ドキュメントには、使用可能なクラス、型、関数、変数の詳細が記載されている。GitHubリポジトリは、SDKの関数やアトリビューションの宣言、コードの変更、バージョン管理に関するインサイトを提供している。各リポジトリには、Brazeの機能をテストしたり、独自のアプリケーションと一緒に実装するために使用できる、完全にビルド可能なサンプルアプリケーションも含まれている。
リソース一覧
現在、いくつかのSDKには専用のリファレンス・ドキュメントがないが、我々は積極的に取り組んでいる。
プラットフォーム | 参考 | リポジトリ | サンプルアプリ |
---|---|---|---|
Android SDK | 参考ドキュメント | GitHubリポジトリ | サンプルアプリ |
SWIFT SDK | 参考ドキュメント | GitHubリポジトリ | サンプルアプリ |
ウェブSDK | 参考ドキュメント | GitHubリポジトリ | サンプルアプリ |
Cordova SDK | 宣言ファイル | GitHubリポジトリ | サンプルアプリ |
Flutter SDK | 参考ドキュメント | GitHubリポジトリ | サンプルアプリ |
ReactネイティブSDK | 宣言ファイル | GitHubリポジトリ | サンプルアプリ |
Roku SDK | N/A | GitHubリポジトリ | サンプルアプリ |
Unity SDK | 宣言ファイル | GitHubリポジトリ | サンプルアプリ |
アンリアルエンジンSDK | N/A | GitHubリポジトリ | サンプルアプリ |
Xamarin SDK | N/A | GitHubリポジトリ | サンプルアプリ |
サンプルアプリを作る
ドロイド・ボーイを作る
Android SDK GitHub repository内のテストアプリケーションは、Droidboy と呼ばれます。次の手順に従って、プロジェクトとともに完全に機能する Droidboy のコピーを構築します。
- 新しいワークスペースを作成し、Braze API 識別子キーを書き留めます。
- FCM 送信者 ID と Braze API 識別子キーを
/droidboy/res/values/braze.xml
内の適切な場所 (それぞれcom_braze_push_fcm_sender_id
とcom_braze_api_key
という文字列のタグの間) にコピーします。 - FCM サーバーキーとサーバー ID を [設定の管理] のワークスペース設定にコピーします。
- Droidboy APK をアセンブルするには、SDK ディレクトリ内で
./gradlew assemble
を実行します。Windows ではgradlew.bat
を使用します。 - Droidboy APK をテストデバイスに自動的にインストールするには、SDK ディレクトリ内で
./gradlew installDebug
を実行します。
“ハローBraze “を作る
Hello Braze テストアプリケーションは、Braze SDK の最小限のユースケースを示し、さらに Braze SDK を Gradle プロジェクトに簡単に統合する方法も示します。
- [設定の管理] ページの API 識別子キーを
res/values
フォルダーのbraze.xml
ファイルにコピーします。 - サンプルアプリをデバイスまたはエミュレーターにインストールするには、SDK ディレクトリ内で次のコマンドを実行します。
1
./gradlew installDebug
ANDROID_HOME
変数が適切に設定されていない場合、または有効なsdk.dir
フォルダーを含むlocal.properties
フォルダーがない場合、このプラグインはベース SDK もインストールします。詳細については、プラグインリポジトリを参照してください。
Android SDK ビルドシステムの詳細については、GitHub リポジトリの README を参照してください。
SWIFTテストアプリを作る
以下の手順に従って、テストアプリケーションをビルドして実行します。
- 新しいワークスペースを作成し、アプリ識別子APIキーおよびエンドポイントに注意してください。
- 統合方法 (Swift Package Manager、CocoaPods、Manual) に基づいて、適切な
xcodeproj
ファイルを選択して開きます。 Credentials
ファイルの適切なフィールドにAPIキーとエンドポイントを配置します。
SDKインテグレーションのQAを行う際、SDKデバッガーを使用すれば、アプリの冗長ロギングをオンにすることなく、問題のトラブルシューティングを行うことができる。