Android SDK 統合
このリファレンス記事では、Android SDK を Android または FireOS アプリケーションに統合する方法について説明します。Braze SDK をインストールすると、基本的な分析機能と、ユーザーエンゲージメントのためのアプリ内メッセージが提供されます。
Android 12 で最適なパフォーマンスを得るには、できるだけ早く Braze Android SDK v13.1.2 以降にアップグレードすることをお勧めします。詳細については、Android 12 アップグレード ガイドを参照してください。
ステップ 1:Braze ライブラリーを統合する
Braze Android SDK は、オプションで UI コンポーネントなしで統合できます。ただし、独自のデザインのみの UI にカスタムデータを渡さない限り、コンテンツカードとアプリ内メッセージングは操作できなくなります。さらに、プッシュ処理コードが UI ライブラリーにあるため、プッシュ通知は機能しません。これらの UI 要素は完全にカスタマイズ可能であることに注意してください。これらの機能を統合することを強くお勧めします。各チャネルまたはツールを使用する利点のリストについては、コンテンツカードとアプリ内メッセージに関するドキュメントを参照してください。
基本的な統合
Braze メッセージング機能にアクセスするには、UI ライブラリーを統合する必要があります。IDE に応じて UI ライブラリーを統合するには、次の Android Studio の手順を参照してください。
Braze 依存関係を追加する
android-sdk-ui
の依存関係をアプリの build.gradle
に追加します。
位置情報や Braze ジオフェンス機能を使用している場合は、android-sdk-location
もアプリの build.gradle
に含めてください。
非ネイティブ Android SDK (Flutter、Cordova、Unity など) を使用している場合、その SDK には正しいバージョンの Android SDK の android-sdk-ui
依存関係がすでに含まれています。そのバージョンを手動で更新しないでください。
1
2
3
4
dependencies {
implementation "com.braze:android-sdk-ui:+"
implementation "com.braze:android-sdk-location:+"
}
次の例は、依存関係行を配置する build.gradle
内の場所を示しています。なお、例で使用しているバージョンは古いバージョンです。Braze Android SDK の最新バージョンについては、Braze Android SDK リリースにアクセスしてください。
Gradle 同期を実行する
Gradle 同期を実行してプロジェクトをビルドし、依存関係の追加を組み込んでください。
ステップ 2:braze.xml で Braze SDK を設定する
2019 年 12 月をもって、カスタムエンドポイントは提供されなくなりました。既存のカスタムエンドポイントがある場合は、それを引き続き使用できます。詳細については、利用可能なエンドポイントのリストを参照してください。
ライブラリーが統合されたので、次に braze.xml
ファイルをプロジェクトの res/values
フォルダーに作成する必要があります。特定のデータクラスターを使用している場合、または既存のカスタムエンドポイントがある場合は、braze.xml
ファイルでもエンドポイントを指定する必要があります。
ファイルの内容は、次のコードスニペットのようになります。Braze ダッシュボードの [設定の管理] ページにある識別子で YOUR_APP_IDENTIFIER_API_KEY
を置き換えてください。クラスターアドレスを確認するには、dashboard.braze.com にログインします。
```xml <?xml version=”1.0” encoding=”utf-8”?>
1
2
3
4
5
6
7
## ステップ 3:必要な権限を AndroidManifest.xml に追加する
API キーを追加したので、次の権限を `AndroidManifest.xml` に追加する必要があります。
```xml
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
Android M のリリースにより、Android はインストール時権限モデルから実行時権限モデルに切り替わりました。ただし、これらの権限はどちらも通常の権限であり、アプリのマニフェストにリストされている場合は自動的に付与されます。詳細については、Android の[権限に関するドキュメント][46]を参照してください。
ステップ 4:Android でユーザーセッションを追跡する
アクティビティライフサイクルコールバックの統合
openSession()
、closeSession()
、`ensureSubscribedToInAppMessageEvents()`、および InAppMessageManager
登録への呼び出しは、オプションで自動的に処理されます。
アクティビティライフサイクルコールバックを登録する
Application
クラスの onCreate()
メソッドに次のコードを追加します。
1
2
3
4
5
6
7
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
registerActivityLifecycleCallbacks(new BrazeActivityLifecycleCallbackListener());
}
}
1
2
3
4
5
6
class MyApplication : Application() {
override fun onCreate() {
super.onCreate()
registerActivityLifecycleCallbacks(BrazeActivityLifecycleCallbackListener())
}
}
`BrazeActivityLifecycleCallbackListener` で使用できるパラメーターの詳細については、SDK リファレンスドキュメントを参照してください。
ステップ 5:位置情報の追跡を有効にする
Braze の位置情報収集機能を有効にする場合は、com_braze_enable_location_collection
を含むように braze.xml
ファイルを更新し、その値が true
に設定されていることを確認します。
1
<bool name="com_braze_enable_location_collection">true</bool>
Braze Android SDK バージョン3.6.0 以降、Braze の位置情報収集機能はデフォルトで無効になっています。
SDK 統合の完了
Braze はアプリケーションから指定されたデータを収集できるようになり、基本的な統合が完了しました。
カスタムイベントトラッキング、プッシュメッセージング、コンテンツカード、および Braze 機能の完全なスイートを有効にするには、次の記事にアクセスしてください。