通知測試人員新版本的消息

選用的 Firebase 應用程式發布 iOS 和 Android SDK 可讓您在可安裝新版應用程式時，向測試人員顯示應用程式內快訊。本指南說明如何使用應用程式發布的 iOS 和 Android SDK，為測試人員建立及自訂新的建構快訊。

事前準備

如果您尚未將 Firebase 新增至 Android 專案，請先完成這項操作。

步驟 1：啟用 App Distribution Tester API

  1. 在 Google Cloud 控制台中選取您的專案。

  2. 按一下 Firebase App Testers API 下方的「啟用」。

步驟 2：在應用程式中新增應用程式發布內容

應用程式發布 Android SDK 包含兩個程式庫：

  • firebase-appdistribution-api - 僅限 API 的程式庫，可納入所有建構變化版本。
  • firebase-appdistribution - 完整的 SDK 實作 (選用)。

僅限 API 的程式庫可讓程式碼呼叫 SDK。如果未顯示完整的 SDK 實作，呼叫將不會產生任何影響。

在模組 (應用程式層級) Gradle 檔案 (通常是 <project>/<app-module>/build.gradle.kts 或 <project>/<app-module>/build.gradle) 中，宣告應用程式發布 Android SDK 的依附元件。如要避免在 Play 版本中加入完整 SDK 實作的自我更新功能，請在所有建構變數中加入僅限 API 的程式庫依附元件。請僅將完整的 SDK 實作新增至用於預先發布測試的變化版本。

dependencies {
    // ADD the API-only library to all variants
    implementation("com.google.firebase:firebase-appdistribution-api:16.0.0-beta13")

    // ADD the full SDK implementation to the "beta" variant only (example)
    betaImplementation("com.google.firebase:firebase-appdistribution:16.0.0-beta13")
}

在尋找 Kotlin 專用的程式庫模組嗎？從 2023 年 10 月版本開始，Kotlin 和 Java 開發人員都能使用主要程式庫模組 (詳情請參閱這項計畫的常見問題)。

步驟 3：設定應用程式內快訊

應用程式發布 Android SDK 提供下列方式，以便為測試人員設定應用程式內建構快訊：

  • 基本的快訊設定，隨附預先建構的應用程式更新和登入對話方塊，會向測試人員顯示。
  • 進階快訊設定，可讓您自訂自己的使用者介面。

如果您是首次使用應用程式發布 Android SDK，建議採用「基本設定」。

基本設定

使用 updateIfNewReleaseAvailable 向尚未啟用快訊的測試人員顯示預先建構的啟用快訊對話方塊，然後檢查是否有可用的新版本。呼叫此方法時，會執行以下序列：

  1. 檢查測試人員是否已啟用快訊。如果測試人員尚未啟用快訊，這個方法會提示測試人員使用自己的 Google 帳戶登入應用程式發布。

  2. 檢查可供測試人員安裝的新版本。

  3. 顯示預先建立的快訊，提示測試人員更新。

  4. 如果新版本是 Android App Bundle (AAB)，請將測試人員重新導向至 Google Play 以完成更新程序。

    如果新版本是 Android 應用程式 PacKage (APK)，則 SDK 會在背景下載新版本，並在下載完成時提示測試人員安裝。SDK 會使用 NotificationManager 將下載進度通知傳送給使用者。您也可以將 onProgressUpdate 處理常式附加至 updateIfNewReleaseAvailable 工作，藉此自行新增進度指標。

您可以在應用程式中隨時呼叫 updateIfNewReleaseAvailable。例如，您可以在應用程式主要活動的 onResume 方法期間呼叫 updateIfNewReleaseAvailable。

下列範例會檢查測試人員是否啟用快訊，並存取新版本。如果符合這些條件，當版本可供安裝時，系統會顯示對話方塊：

Kotlin+KTX 

// Copy and paste this into any part of your app - for example, in your main
// activity's onResume method.
val firebaseAppDistribution = FirebaseAppDistribution.getInstance()
firebaseAppDistribution.updateIfNewReleaseAvailable()
    .addOnProgressListener { updateProgress ->
      // (Optional) Implement custom progress updates in addition to
      // automatic NotificationManager updates.
    }
    .addOnFailureListener { e ->
      // (Optional) Handle errors.
      if (e is FirebaseAppDistributionException) {
        when (e.errorCode) {
          Status.NOT_IMPLEMENTED -> {
            // SDK did nothing. This is expected when building for Play.
          }
          else -> {
            // Handle other errors.
          }
        }
      }
    }

Java 

// Copy and paste this into any part of your app - for example, in your main
// activity's onResume method.
FirebaseAppDistribution firebaseAppDistribution = FirebaseAppDistribution.getInstance();
firebaseAppDistribution.updateIfNewReleaseAvailable()
    .addOnProgressListener(updateProgress -> {
      // (Optional) Implement custom progress updates in addition to
      // automatic NotificationManager updates.
    })
    .addOnFailureListener(e -> {
      // (Optional) Handle errors.
      if (e instanceof FirebaseAppDistributionException) {
        switch (((FirebaseAppDistributionException)e).getErrorCode()) {
          case NOT_IMPLEMENTED:
            // SDK did nothing. This is expected when building for Play.
            break;
          default:
            // Handle other errors.
            break;
        }
      }
    });

進階設定

進階登入設定

signInTester 和 isTesterSignedIn 方法可讓您更靈活地自訂測試人員的登入體驗，讓測試人員能更符合應用程式的外觀和風格。

以下範例會檢查測試人員是否已登入應用程式發布測試人員帳戶。如此一來，您可以選擇只向尚未登入的測試人員顯示登入使用者介面 (UI)。測試人員登入後，即可呼叫 updateIfNewReleaseAvailable 來檢查測試人員是否有權存取新版本。

Kotlin+KTX 

// Only show sign-in UI if this is the "beta" variant (example).
if (BuildConfig.BUILD_TYPE == "beta" && !firebaseAppDistribution.isTesterSignedIn) {
    // Start your sign-in UI here.
}

// Only check for updates if the tester is already signed in (do not prompt).
if (firebaseAppDistribution.isTesterSignedIn) {
    firebaseAppDistribution.updateIfNewReleaseAvailable().addOnFailureListener {
        // Handle failed update.
    }
}

Java 

// Only show sign-in UI if this is the "beta" variant (example).
if (BuildConfig.BUILD_TYPE == "beta" && !firebaseAppDistribution.isTesterSignedIn()) {
    // Start your sign-in UI here.
}

// Only check for updates if the tester is already signed in (do not prompt).
if (firebaseAppDistribution.isTesterSignedIn()) {
    firebaseAppDistribution.updateIfNewReleaseAvailable().addOnFailureListener( e -> {
        // Handle failed update.
    });
}

當測試人員選擇繼續進行時，在登入 UI 中呼叫 signInTester()：

Kotlin+KTX 

firebaseAppDistribution.signInTester().addOnSuccessListener {
  // Handle successful sign-in.
}.addOnFailureListener {
  // Handle failed sign-in.
});

Java 

firebaseAppDistribution.signInTester().addOnSuccessListener( unused -> {
  // Handle successful sign-in.
}).addOnFailureListener(e -> {
  // Handle failed sign-in.
});

進階更新設定

透過 checkForNewRelease 和 updateApp 方法，您可以更靈活地自訂收到測試人員更新提示的時機。您也可以自訂預先建構的更新對話方塊和下載進度指標，使其更符合應用程式的外觀和風格。

請注意，updateApp 不會提供下載進度指標，這表示，您需要使用 NotificationManager、某種應用程式內狀態顯示或其他方法，自行實作進度指標。

以下範例會檢查新版本是否可用，然後顯示自訂 UI。呼叫 checkForNewRelease 和 updateApp 之前，請使用進階登入設定，確認測試人員已登入。

Kotlin+KTX 

firebaseAppDistribution.checkForNewRelease().addOnSuccessListener { release ->
    if (release != null) {
        // New release available. Start your update UI here.
    }
}.addOnFailureListener {
    // Handle failed check for new release. Fails with Status#NOT_IMPLEMENTED
    // if built for Play.
}

Java 

firebaseAppDistribution.checkForNewRelease().addOnSuccessListener(release -> {
    if (release != null) {
        // New release available. Start your update UI here.
    }
}).addOnFailureListener(e -> {
    // Handle failed check for new release. Fails with Status#NOT_IMPLEMENTED
    // if built for Play.
});

當測試人員選擇透過更新 UI 更新時，請呼叫 updateApp()：

Kotlin+KTX 

firebaseAppDistribution.updateApp()
    .addOnProgressListener { updateState ->
      // Use updateState to show update progress.
    }

Java 

firebaseAppDistribution.updateApp()
    .addOnProgressListener(updateState -> {
      // Use updateState to show update progress.
    });

步驟 4：建構並測試實作成果

使用 Firebase 主控台發布版本給測試人員，藉此建構應用程式並測試實作結果。

請參閱應用程式發布疑難排解指南，取得常見問題的說明，例如：

  • 測試人員沒有收到應用程式內快訊
  • 系統多次提示測試人員登入 Google