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)中,添加 In-App Messaging 库的依赖项。我们建议使用 Firebase Android BoM 来实现库版本控制。

如需使用 In-App Messaging,您必须在 Firebase 项目中启用 Google Analytics,并将 Firebase SDK for Google Analytics 添加到您的应用。

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.7.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 每天仅从服务器检索一次消息。这可能会使测试难以进行,因此 Firebase 控制台允许您指定一部测试设备来按需显示消息。

该测试设备由 FirebaseInstallations ID(即 FID)确定。 如需查找测试应用的 FID,请检查 Android Studio 中的 Logcat 以获取以下“信息”级日志:

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

向您的测试设备发送消息

在测试设备上启动应用并获得 Firebase 安装 ID (FID) 后,您可以发送测试消息来试用 Firebase In-App Messaging 设置:

  1. Firebase 控制台中,打开“Messaging”(消息传递)页面
  2. 如果这是您的第一个宣传活动,请点击制作首个宣传活动
    1. 选择 Firebase 应用内消息,然后点击创建
  3. 否则,请在宣传活动标签页上点击新建宣传活动
    1. 选择 In-App Messaging
  4. 输入第一条消息的标题
  5. 点击在设备上测试
  6. 添加安装 ID 字段中输入应用的 Firebase 安装 ID。
  7. 点击测试发送消息。

在您点击测试后,Firebase In-App Messaging 会立即发送测试消息。如需查看该消息,您需要在测试设备上关闭应用,然后重新打开应用。

如需确认您的设备是否为测试设备,请查找以下日志消息:

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