Skip to content

リファレンス、リポジトリ、サンプルアプリ

これは、各 Braze SDKに属するリファレンスドキュメント、GitHubリポジトリ、サンプルアプリの一覧です。SDKのリファレンスドキュメントには、使用可能なクラス、型、関数、変数の詳細が記載されています。GitHubリポジトリは、SDKの関数や属性の宣言、コードの変更、バージョン管理に関するインサイトを提供します。各リポジトリには、Brazeの機能をテストしたり、独自のアプリケーションと併せて実装するために使用できる、完全にビルド可能なサンプルアプリケーションも含まれています。

ドキュメント内のミラーリングされたリポジトリREADMEコンテンツについては、リポジトリガイドを参照してください。

リソース一覧

プラットフォーム リファレンス リポジトリ サンプルアプリ
Android SDK リファレンスドキュメント GitHub リポジトリ サンプルアプリ
Swift SDK リファレンスドキュメント GitHub リポジトリ サンプルアプリ
Web SDK リファレンスドキュメント GitHub リポジトリ サンプルアプリ
Javascript SDK リファレンスドキュメント GitHub リポジトリ N/A
Cordova SDK 宣言ファイル GitHub リポジトリ サンプルアプリ
Flutter SDK リファレンスドキュメント GitHub リポジトリ サンプルアプリ
React Native SDK リファレンスドキュメント GitHub リポジトリ サンプルアプリ
Vega SDK リファレンスドキュメント GitHub リポジトリ N/A
Roku SDK N/A GitHub リポジトリ サンプルアプリ
Unity SDK 宣言ファイル GitHub リポジトリ サンプルアプリ
.NET MAUI SDK（旧 Xamarin） N/A GitHub リポジトリ サンプルアプリ

サンプルアプリのビルド

「Droidboy」のビルド

Android SDK GitHub リポジトリ内のテストアプリケーションは Droidboy と呼ばれます。以下の手順に従って、プロジェクトと並行して完全に機能するコピーをビルドしてください。

  1. 新しいワークスペースを作成し、Braze API 識別子キーをメモします。

  2. FCM 送信者 ID と Braze API 識別子キーを /droidboy/res/values/braze.xml 内の適切な場所（それぞれ com_braze_push_fcm_sender_id および com_braze_api_key という名前の文字列タグの間）にコピーします。

  3. FCM サーバーキーとサーバー ID を、ワークスペース設定の設定の管理にコピーします。

  4. Droidboy APK をアセンブルするには、SDK ディレクトリ内で ./gradlew assemble を実行します。Windows では gradlew.bat を使用してください。

  5. テストデバイスに Droidboy APK を自動的にインストールするには、SDK ディレクトリ内で ./gradlew installDebug を実行します。

「Hello Braze」のビルド

Hello Braze テストアプリケーションは、Braze SDKの最小限のユースケースを示し、さらに Gradle プロジェクトに Braze SDKを簡単に統合する方法を示します。

  1. 設定の管理ページから API 識別子キーを res/values フォルダ内の braze.xml ファイルにコピーします。 「Hello Braze」のビルドに関するスクリーンショット

  2. サンプルアプリをデバイスまたはエミュレーターにインストールするには、SDK ディレクトリ内で以下のコマンドを実行します。 
    1

    ./gradlew installDebug

    ANDROID_HOME 変数が正しく設定されていない場合、または有効な sdk.dir フォルダを含む local.properties フォルダがない場合、このプラグインはベース SDKも自動的にインストールします。詳細については、プラグインリポジトリを参照してください。

Android SDK ビルドシステムの詳細については、GitHub リポジトリの README を参照してください。

Swift テストアプリのビルド

以下の手順に従って、テストアプリケーションをビルドおよび実行してください。

  1. 新しいワークスペースを作成し、アプリ識別子 API キーとエンドポイントをメモします。
  2. 統合方法（Swift Package マネージャー、CocoaPods、手動）に基づいて、適切な xcodeproj ファイルを選択して開きます。
  3. API キーとエンドポイントを Credentials ファイルの適切なフィールドに入力します。
New Stuff!