Firebase In-App Messaging を使ってみる

このクイックスタートでは、Firebase In-App Messaging を設定して最初のメッセージを送信する方法について説明します。

始める前に

まだ Firebase を Android プロジェクトに追加していない場合は追加します。

プロジェクトに Firebase In-App Messaging SDK を追加する

モジュール（アプリレベル）の Gradle ファイル（通常は <project>/<app-module>/build.gradle.kts または <project>/<app-module>/build.gradle）に、Android 用 In-App Messaging ライブラリの依存関係を追加します。ライブラリのバージョニングの制御には、Firebase Android BoM を使用することをおすすめします。

In-App Messaging を使用するには、Firebase プロジェクトで Google Analytics を有効にして、Google アナリティクス用の Firebase SDK をアプリに追加する必要があります。

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.6.0"))

    // Add the dependencies for the In-App Messaging and Analytics libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-inappmessaging-display")
    implementation("com.google.firebase:firebase-analytics")
}

Firebase Android BoM を使用すると、アプリは常に互換性のあるバージョンの Firebase Android ライブラリを使用します。

（代替方法）BoM を使用せずに Firebase ライブラリの依存関係を追加する

Firebase BoM を使用しない場合は、依存関係の行でそれぞれの Firebase ライブラリのバージョンを指定する必要があります。

アプリで複数の Firebase ライブラリを使用する場合は、すべてのバージョンの互換性を確保するため、BoM を使用してライブラリのバージョンを管理することを強くおすすめします。

dependencies {
    // Add the dependencies for the In-App Messaging and Analytics libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-inappmessaging-display:21.0.1")
    implementation("com.google.firebase:firebase-analytics:22.1.2")
}

Kotlin 固有のライブラリモジュールをお探しの場合、 2023 年 10 月（Firebase BoM 32.5.0）以降、Kotlin と Java の両方のデベロッパーがメインライブラリモジュールを使用できるようになります（詳しくは、このイニシアチブに関するよくある質問をご覧ください）。

テストメッセージを送信する

アプリのインストール ID を取得する

電力を節約するため、Firebase In-App Messaging はサーバーからのメッセージの取得を 1 日に 1 回だけ行います。このような設定ではテストが困難になることがあるため、Firebase コンソールでは、メッセージをオンデマンドで表示するテストデバイスを指定することができます。

このテストデバイスは FirebaseInstallations ID（FID）によって決定されます。テスト用アプリの FID を特定するには、Android Studio の Logcat で次の「Info」レベルのログを検索してください。

I/FIAM.Headless: Starting InAppMessaging runtime with Installation ID YOUR_INSTALLATION_ID

テストデバイスにメッセージを送る

テストデバイスでアプリを起動し、Firebase インストール ID（FID）を取得したら、テストメッセージを送信して Firebase In-App Messaging の設定を試すことができます。

Firebase コンソールで、[メッセージング] ページを開きます。
初めてキャンペーンを作成する場合、[最初のキャンペーンを作成] をクリックします。
1. [Firebase In-App メッセージ] を選択し、[作成] をクリックします。
それ以外の場合は、[キャンペーン] タブで [新しいキャンペーンを作成] をクリックします。
1. [In-App Messaging] を選択します。
最初のメッセージのタイトルを入力します。
[デバイスでテスト] をクリックします。
[Add an installation ID] フィールドにアプリの Firebase インストール ID を入力します。
[テスト] をクリックしてメッセージを送信します。

Firebase In-App Messaging [テスト] をクリックするとすぐにテストメッセージが送信されます。このメッセージを表示するには、テストデバイスでアプリを閉じてから開き直します。

デバイスがテストデバイスかどうかを確認するには、次のログメッセージを探します。

I/FIAM.Headless: Setting this device as a test device