שליחת הודעה לבודקים על גרסאות build חדשות


ערכות ה-SDK האופציונליות של Firebase App Distribution ל-iOS ול-Android מאפשרות לכם להציג התראות באפליקציה לבודקים כשגרסאות build חדשות של האפליקציה זמינות להתקנה. במדריך הזה מוסבר איך להשתמש ב-SDK של App Distribution ל-iOS ול-Android כדי ליצור התראות על גרסאות build חדשות ולהתאים אותן אישית למטרות בדיקה.

לפני שמתחילים

אם עדיין לא עשיתם זאת, מוסיפים את Firebase לפרויקט ל-iOS.

שלב 1: מפעילים את App Distribution Tester API

  1. בוחרים את הפרויקט במסוף Google Cloud.

  2. בקטע Firebase App Testers API, לוחצים על Enable (הפעלה).

שלב 2: מוסיפים את App Distribution לאפליקציה

  1. פותחים את קובץ ה-Podfile שיצרתם לפרויקט (או מריצים את הפקודה pod init כדי ליצור קובץ כזה), ומוסיפים את השורה הבאה בקטע target:

    pod 'FirebaseAppDistribution'

  2. בספרייה של קובץ ה-podfile, מריצים את הפקודה pod install ואז פותחים את הקובץ .xcworkspace שנוצר.

  3. מייבאים את מודול Firebase ב-struct‏ App או ב-UIApplicationDelegate:

    Swift

    import FirebaseCore
import FirebaseAppDistribution

    Objective-C

    @import FirebaseCore;
@import FirebaseAppDistribution;

  4. מגדירים מופע משותף של FirebaseApp בשיטה application(_:didFinishLaunchingWithOptions:) של הנציג של האפליקציה:

    Swift

    // Use Firebase library to configure APIs
FirebaseApp.configure()

    Objective-C

    // Use Firebase library to configure APIs
[FIRApp configure];

  5. אם החלפת כתובות ה-URL מושבתת, מעבירים את כתובות ה-URL הפתוחות ל-SDK של App Distribution בהטמעה של application(_:open:options:):

    Swift

    func application(_ app: UIApplication, 
                 open url: URL,
                 options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
   if AppDistribution.appDistribution().application(application, open: url, options: options) {
      return true
   }

   // Handle other non-Firebase URLs here.

   return false
}

    Objective-C

    - (BOOL)application:(UIApplication *)app 
            openURL:(NSURL *)url 
            options:(NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options {
   if ([[FIRAppDistribution appDistribution] application:app openURL:url options:options]) {
      return YES;
   }

   // Handle other non-Firebase URLs here.

   return NO;
}

  6. לבסוף, צריך לבצע הידור מחדש של האפליקציה.

שלב 3: מגדירים התראות בתוך האפליקציה

ערכת ה-SDK של App Distribution מספקת שתי דרכים להגדרת התראות על גרסאות build באפליקציה למפתחים: הגדרת התראות בסיסית, שכוללת תיבת דו-שיח מובנית לעדכון האפליקציה ולכניסה, והגדרת התראות מתקדמת שמאפשרת להתאים אישית את ממשק המשתמש. אם זו הפעם הראשונה שאתם משתמשים ב-SDK של App Distribution, מומלץ להשתמש קודם בהגדרה הבסיסית של ההתראות.

הגדרה בסיסית

משתמשים ב-checkForUpdate כדי להציג תיבת דו-שיח מוכנה מראש להפעלת התראות למפתחים שעדיין לא הפעילו את ההתראות, ולאחר מכן בודקים אם יש גרסה חדשה של build. כשמפעילים את ה-method, הוא מבצע את התהליך הבא:

  1. הבדיקה בודקת אם הבוחן הפעיל התראות על ידי הצגת בקשה להיכנס ל-App Distribution באמצעות חשבון Google שלו.

  2. אם הבוחן עדיין לא הפעיל התראות, יוצג תיבת דו-שיח מוגדרת מראש.

    הפעלת ההתראות היא תהליך חד-פעמי במכשיר הבדיקה, והיא נשמרת גם אחרי עדכוני האפליקציה. ההתראות יישארו מופעלות במכשיר הבדיקה עד להסרת האפליקציה או עד לקריאה ל-method‏ signOutTester. מידע נוסף זמין במסמכי העזרה של השיטה (Swift או Objective-C).

  3. הבדיקה נועדה לזהות גרסאות build חדשות שזמינות למתקין.

אפשר להפעיל את checkForUpdate() בכל שלב באפליקציה. לדוגמה, תוכלו לבקש מהבודקים להתקין גרסאות build חדשות שזמינות בזמן ההפעלה, על ידי הוספת checkForUpdate() ל-onAppear(perform:) בתצוגת הבסיס של האפליקציה.

בדוגמה הבאה בודקים אם למבצע הבדיקה יש התראות מופעלות וגישה ל-build חדש. אם כן, מוצגת תיבת דו-שיח כשה-build זמין להתקנה:

Swift

הערה: המוצר הזה לא זמין ביעדים של macOS, ‏ Mac Catalyst, ‏ tvOS או watchOS. 
AppDistribution.appDistribution().checkForUpdate(completion: { release, error in
  if error != nil {
      // Handle error
      return
  }

  guard let release = release else {
    return
  }

  // Customize your alerts here.
  let title = "New Version Available"
  let message = "Version \(release.displayVersion)(\(release.buildVersion)) is available."
  let uialert = UIAlertController(title: title,message: message, preferredStyle: .alert)

  uialert.addAction(UIAlertAction(title: "Update", style: UIAlertAction.Style.default) {
    _ in
    UIApplication.shared.open(release.downloadURL)
  })
  uialert.addAction(UIAlertAction(title: "Cancel", style: UIAlertAction.Style.cancel) {
    _ in
  })

  // self should be a UIViewController.
  self.present(uialert, animated: true, completion: nil)
})

Objective-C

הערה: המוצר הזה לא זמין ביעדים של macOS, ‏ Mac Catalyst, ‏ tvOS או watchOS. 
[[FIRAppDistribution appDistribution]
  checkForUpdateWithCompletion:^(FIRAppDistributionRelease *_Nullable release,
                                 NSError *_Nullable error) {
  if (error) {
    // Handle error
    return;
  }

  if (release) {
    UIAlertController *alert = [UIAlertController alertControllerWithTitle:@"New Version Available"
message:[NSString stringWithFormat:@"Version %@ (%@) is available.", release.displayVersion,
release.buildVersion] preferredStyle:UIAlertControllerStyleAlert];

    UIAlertAction *updateAction = [UIAlertAction actionWithTitle:@"Update"
style:UIAlertActionStyleDefault handler:^(UIAlertAction *action) {
      [[UIApplication sharedApplication] openURL:release.downloadURL options:@{}
completionHandler:nil];
    }];
    UIAlertAction *cancelAction = [UIAlertAction actionWithTitle:@"Cancel"
style:UIAlertActionStyleCancel handler:^(UIAlertAction *action) {}];
    [alert addAction:updateAction];
    [alert addAction:cancelAction];
    [self presentViewController:alert animated:YES completion:nil];
  }
}];

הגדרה מתקדמת

השיטות signInTester() ו-isTesterSignedIn מספקות גמישות רבה יותר בהתאמה אישית של חוויית הכניסה של הבוחנים, כך שתתאים יותר למראה ולתחושה של האפליקציה.

בדוגמה הבאה בודקים אם הבודק כבר נכנס לחשבון הבדיקה שלו ב-Firebase App Distribution, כדי שתוכלו להציג את ממשק המשתמש של הכניסה רק לבודקים שעדיין לא נכנסו. אחרי שהבודק נכנס לחשבון, אפשר להריץ את הפקודה checkForUpdate() כדי לבדוק אם יש לו גישה לגרסה החדשה.

Swift

הערה: המוצר הזה לא זמין ביעדים של macOS, ‏ Mac Catalyst, ‏ tvOS או watchOS. 
// Sign in a tester without automatically checking for update
if (!AppDistribution.appDistribution().isTesterSignedIn) {
  AppDistribution.appDistribution().signInTester (completion: { error in
    // completion block for signInTester
     if (error != nil) {
       // handle failed sign in
      return
     }
    // handle successful sign in
  })
}

// Only check for update if tester is already signed in - do not prompt
if (AppDistribution.appDistribution().isTesterSignedIn) {
  AppDistribution.appDistribution().checkForUpdate(completion: { release, error in
      // completion block for check for update
  })
}

Objective-C

הערה: המוצר הזה לא זמין ביעדים של macOS, ‏ Mac Catalyst, ‏ tvOS או watchOS. 
// Sign in a tester without automatically checking for update
if(![[FIRAppDistribution appDistribution] isTesterSignedIn]) {
  [[FIRAppDistribution appDistribution]
    signInTesterWithCompletion:^(NSError *_Nullable error) {
      // completion block for signInTester
     if (error) {
       // handle failed sign in
       return;
     }
      // handle successful sign in
  }];
}

// only check for update if tester is already signed in - do not prompt
if([[FIRAppDistribution appDistribution] isTesterSignedIn]) {
  [[FIRAppDistribution appDistribution]
        checkForUpdateWithCompletion:^(FIRAppDistributionRelease *_Nullable release,
                                       NSError *_Nullable error) {
     // completion block for check for update
  }];
}

למידע על שיטות נוספות, כולל signOutTester(), תוכלו לעיין במאמרי העזרה של App Distribution ל-Swift ול-Objective-C.

שלב 4: פיתוח ובדיקה של ההטמעה

לבסוף, מפתחים את האפליקציה ובודקים את ההטמעה על ידי הפצת הגרסה היציבה לבודקים באמצעות מסוף Firebase.

במדריך לפתרון בעיות ב-App Distribution מוסבר איך לפתור בעיות נפוצות, כמו:

  • הבודק לא מקבל התראות מתוך האפליקציה
  • הבודק מתבקש להיכנס לחשבון Google יותר מפעם אחת