リファレンス、リポジトリ、サンプルアプリ
これは、各 Braze SDK に属するリファレンスドキュメント、GitHub リポジトリ、サンプルアプリの一覧です。SDK のリファレンスドキュメントには、使用可能なクラス、型、関数、変数の詳細が記載されています。GitHub リポジトリは、SDK の関数や属性の宣言、コードの変更、バージョン管理に関するインサイトを提供します。各リポジトリには、Braze の機能をテストしたり、独自のアプリケーションと併せて実装するために使用できる、完全にビルド可能なサンプルアプリケーションも含まれています。
リソース一覧
現在、一部の SDK には専用のリファレンスドキュメントがありませんが、積極的に作成に取り組んでいます。
| プラットフォーム | 参照 | リポジトリ | サンプルアプリ |
|---|---|---|---|
| Android SDK | リファレンスドキュメント | GitHub リポジトリ | サンプルアプリ |
| Swift SDK | リファレンスドキュメント | GitHub リポジトリ | サンプルアプリ |
| Web SDK | リファレンスドキュメント | GitHub リポジトリ | サンプルアプリ |
| Cordova SDK | 宣言ファイル | GitHub リポジトリ | サンプルアプリ |
| Flutter SDK | リファレンスドキュメント | GitHub リポジトリ | サンプルアプリ |
| React Native SDK | 宣言ファイル | GitHub リポジトリ | サンプルアプリ |
| Roku SDK | N/A | GitHub リポジトリ | サンプルアプリ |
| Unity SDK | 宣言ファイル | GitHub リポジトリ | サンプルアプリ |
| .NET MAUI SDK(旧称 Xamarin) | N/A | GitHub リポジトリ | サンプルアプリ |
サンプルアプリのビルド
「Droidboy」のビルド
Android SDK GitHub リポジトリ内のテストアプリケーションは 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を実行します。
「Hello 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、手動)に基づいて、適切な
xcodeprojファイルを選択して開きます。 Credentialsファイルの適切なフィールドに API キーとエンドポイントを入力します。
SDK インテグレーションの QA を行う際は、SDK デバッガーを使用すれば、アプリの冗長ロギングをオンにすることなく問題のトラブルシューティングを行うことができます。
GitHub でこのページを編集