แจ้งเตือนผู้ทดสอบเกี่ยวกับบิลด์ใหม่

Firebase App Distribution SDK สำหรับ iOS และ Android ช่วยให้คุณแสดงการแจ้งเตือนในแอปแก่ผู้ทดสอบเมื่อมีแอปรุ่นใหม่พร้อมให้ติดตั้ง คู่มือนี้อธิบายวิธีใช้ App Distribution SDK สำหรับ iOS และ Android เพื่อสร้างและปรับแต่งการแจ้งเตือนบิลด์ใหม่สำหรับผู้ทดสอบ

ก่อนเริ่มต้น

เพิ่ม Firebase ลงในโปรเจ็กต์ Android หากยังไม่ได้ทำ

ขั้นตอนที่ 1: เปิดใช้ App Distribution Tester API

  1. เลือกโปรเจ็กต์ใน Google Cloud Console

  2. คลิกเปิดใช้ในส่วน Firebase App Testers API

ขั้นตอนที่ 2: เพิ่ม App Distribution ลงในแอป

App Distribution Android SDK ประกอบด้วยไลบรารี 2 รายการต่อไปนี้

  • firebase-appdistribution-api - ไลบรารีแบบ API เท่านั้น ซึ่งคุณจะรวมไว้ในเวอร์ชันบิลด์ทั้งหมดได้
  • firebase-appdistribution - การใช้งาน SDK เต็มรูปแบบ (ไม่บังคับ)

ไลบรารีแบบ API เท่านั้นจะทำให้โค้ดของคุณเรียก SDK ได้ การเรียกจะไม่มีผลหากไม่มีการใช้งาน SDK เต็มรูปแบบ

ประกาศทรัพยากร Dependency สำหรับ Android SDK ของ App Distribution ในไฟล์ Gradle ของโมดูล (ระดับแอป) (โดยทั่วไปจะเป็น <project>/<app-module>/build.gradle.kts หรือ <project>/<app-module>/build.gradle) หากต้องการหลีกเลี่ยงการรวมฟังก์ชันการอัปเดตด้วยตนเองของการติดตั้ง SDK แบบเต็มไว้ในบิลด์ Play ให้เพิ่มทรัพยากร Dependency ของไลบรารีเฉพาะ 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 เป็นต้นไป ทั้งนักพัฒนา Kotlin และ Java สามารถใช้โมดูลไลบรารีหลักได้ (ดูรายละเอียดได้ที่คำถามที่พบบ่อยเกี่ยวกับโครงการริเริ่มนี้)

ขั้นตอนที่ 3: กำหนดค่าการแจ้งเตือนในแอป

App Distribution Android SDK มอบวิธีต่อไปนี้ในการตั้งค่าการแจ้งเตือนบิลด์ในแอปให้กับผู้ทดสอบ

  • การกำหนดค่าการแจ้งเตือนพื้นฐานที่มาพร้อมกับการอัปเดตแอปและกล่องโต้ตอบการลงชื่อเข้าใช้ที่สร้างไว้ล่วงหน้าเพื่อแสดงต่อผู้ทดสอบ
  • การกำหนดค่าการแจ้งเตือนขั้นสูงที่ช่วยให้คุณปรับแต่งอินเทอร์เฟซผู้ใช้ของคุณเองได้

หากคุณใช้ App Distribution Android SDK เป็นครั้งแรก เราขอแนะนำให้ใช้การกำหนดค่าพื้นฐาน

การกำหนดค่าพื้นฐาน

ใช้ updateIfNewReleaseAvailable เพื่อแสดงกล่องโต้ตอบการเปิดใช้การแจ้งเตือนที่สร้างไว้ล่วงหน้าสำหรับผู้ทดสอบที่ยังไม่ได้เปิดใช้การแจ้งเตือน จากนั้นตรวจสอบว่ามีรุ่นใหม่พร้อมใช้งานหรือไม่ เมื่อเรียกใช้ เมธอดจะออกลำดับต่อไปนี้

  1. ตรวจสอบว่าผู้ทดสอบเปิดใช้การแจ้งเตือนไว้หรือไม่ หากผู้ทดสอบยังไม่ได้เปิดใช้การแจ้งเตือน ระบบจะแจ้งให้ผู้ทดสอบลงชื่อเข้าใช้ App Distribution ด้วยบัญชี Google

  2. ตรวจสอบบิลด์ที่เพิ่งพร้อมใช้งานเพื่อให้ผู้ทดสอบติดตั้ง

  3. แสดงการแจ้งเตือนที่สร้างไว้ล่วงหน้าเพื่อบอกให้ผู้ทดสอบอัปเดต

  4. หากเวอร์ชันใหม่เป็น Android App Bundle (AAB) ให้เปลี่ยนเส้นทางผู้ทดสอบไปยัง Google Play เพื่อดำเนินการอัปเดตให้เสร็จสมบูรณ์

    หากบิลด์ใหม่เป็น PacKage (APK) ของแอปพลิเคชัน Android SDK จะดาวน์โหลดบิลด์ใหม่ในเบื้องหลังและแจ้งให้ผู้ทดสอบติดตั้งเมื่อดาวน์โหลดเสร็จแล้ว SDK จะส่งการแจ้งเตือน ความคืบหน้าในการดาวน์โหลดไปยังผู้ใช้โดยใช้ NotificationManager คุณยังเพิ่มตัวบ่งชี้ความคืบหน้าของตัวเองได้โดยการแนบเครื่องจัดการ onProgressUpdate เข้ากับงาน updateIfNewReleaseAvailable

คุณโทรหา updateIfNewReleaseAvailable ได้ทุกเมื่อในแอป เช่น เรียกใช้ updateIfNewReleaseAvailable ระหว่างการใช้เมธอด onResume ในกิจกรรมหลักของแอป

ตัวอย่างต่อไปนี้จะตรวจสอบว่าผู้ทดสอบเปิดใช้การแจ้งเตือนและมีสิทธิ์เข้าถึงบิลด์ใหม่หรือไม่ หากตรงตามเงื่อนไขเหล่านี้ กล่องโต้ตอบจะปรากฏขึ้นเมื่อพร้อมติดตั้งบิลด์

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 ช่วยให้คุณปรับแต่งประสบการณ์การลงชื่อเข้าใช้ของผู้ทดสอบได้อย่างยืดหยุ่นมากขึ้น เพื่อให้ประสบการณ์ของผู้ทดสอบเข้ากับรูปลักษณ์ของแอปได้ดียิ่งขึ้น

ตัวอย่างต่อไปนี้จะตรวจสอบว่าผู้ทดสอบได้ลงชื่อเข้าใช้บัญชีผู้ทดสอบ App Distribution แล้วหรือไม่ วิธีนี้ช่วยให้คุณเลือกที่จะแสดงอินเทอร์เฟซผู้ใช้ (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

ไปที่คู่มือการแก้ปัญหาเกี่ยวกับ App Distribution เพื่อดูความช่วยเหลือเกี่ยวกับปัญหาทั่วไป เช่น

  • ผู้ทดสอบไม่ได้รับการแจ้งเตือนในแอป
  • ผู้ทดสอบได้รับแจ้งให้ลงชื่อเข้าใช้ Google มากกว่า 1 ครั้ง