איך להודיע למבדקים על הגרסאות החדשות של האפליקציה באמצעות Firebase App Distribution iOS SDK – Codelab

1. סקירה כללית

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

מה תלמדו

  • איך משתמשים בהפצת אפליקציות כדי להפיץ אפליקציה טרום-השקה לבודקים פעילים
  • איך משלבים את App Distribution iOS SDK באפליקציה
  • איך מתריעים לבודק כשגרסת טרום-השקה חדשה מוכנה להתקנה
  • איך להתאים אישית את ה-SDK כדי שיתאים לצרכים הייחודיים שלכם בבדיקות

מה צריך

  • ‫Xcode 12 (או גרסה מתקדמת יותר)
  • ‫CocoaPods מגרסה 1.9.1 (ואילך)
  • חשבון מפתח של אפל להפצה אד-הוק
  • מכשיר iOS פיזי לבדיקה. (אפליקציית הסימולטור של iOS תפעל ברוב המקרים של ה-codelab, אבל אי אפשר להוריד גרסאות באמצעות סימולטורים).

איך תשתמשו במדריך הזה?

רק לקרוא לקרוא ולבצע את התרגילים

איך היית מדרג את חוויית הפיתוח של אפליקציות ל-iOS?

מתחילים ביניים מומחים

2. יצירה והגדרה של פרויקט Firebase

יצירת פרויקט חדש ב-Firebase

  1. נכנסים למסוף Firebase באמצעות חשבון Google.
  2. לוחצים על הלחצן ליצירת פרויקט חדש ומזינים שם לפרויקט (לדוגמה, App Distribution Codelab).
  3. לוחצים על המשך.
  4. אם מוצגת בקשה לעשות זאת, קוראים ומאשרים את התנאים של Firebase, ואז לוחצים על המשך.
  5. (אופציונלי) מפעילים את העזרה מבוססת-AI במסוף Firebase (שנקראת 'Gemini ב-Firebase').
  6. ב-codelab הזה לא צריך להשתמש ב-Google Analytics, ולכן משביתים את האפשרות של Google Analytics.
  7. לוחצים על יצירת פרויקט, מחכים שהפרויקט יוקצה ולוחצים על המשך.

הוספת אפליקציה ל-Firebase

פועלים לפי התיעוד כדי לרשום את האפליקציה ב-Firebase. משתמשים ב-com.google.firebase.codelab.AppDistribution.<your_name> כמזהה החבילה ב-iOS.

כשמתבקשים, מורידים את הקובץ GoogleService-Info.plist של הפרויקט. יהיה צורך במידע הזה בהמשך.

3. קבלת פרויקט לדוגמה

הורדת הקוד

מתחילים בשיבוט של פרויקט לדוגמה.

git clone git@github.com:googlecodelabs/firebase-appdistribution-ios.git

אם לא התקנתם את git, אתם יכולים גם להוריד את פרויקט הדוגמה מדף GitHub שלו או בלחיצה על הקישור הזה.

הורדת יחסי תלות ופתיחת הפרויקט ב-Xcode

  1. פותחים את Podfile באותה ספרייה.
cd firebase-appdistribution-ios/start
Open Podfile
  1. מוסיפים את השורה הבאה לקובץ podfile:

Podfile

pod 'Firebase/AppDistribution'

מריצים את הפקודה pod update בספריית הפרויקט ופותחים את הפרויקט ב-Xcode.

pod install --repo-update
xed .

עדכון מזהה החבילה כך שיתאים לאפליקציית Firebase שלכם

בתפריט הימני, לוחצים לחיצה כפולה על AppDistributionExample. לאחר מכן, מאתרים את הכרטיסייה כללי ומשנים את מזהה החבילה כך שיתאים למזהה החבילה של אפליקציית Firebase, שמופיע בהגדרות הפרויקט. הערך צריך להיות com.google.firebase.codelab.AppDistribution.<your_name>‎

הוספת Firebase לאפליקציה

מאתרים את קובץ GoogleService-Info.plist שהורדתם קודם במערכת הקבצים וגוררים אותו לתיקיית השורש של פרויקט Xcode. אפשר גם להוריד את הקובץ הזה בכל שלב מדף ההגדרות של הפרויקט.

3cf9290805e7fdab.png

בייבוא הקובץ AppDistributionExample/AppDelegate.swift ל-Firebase, בחלק העליון של הקובץ

AppDistributionExample/AppDelegate.swift

import Firebase

וב-method‏ didFinishLaunchingWithOptions מוסיפים קריאה להגדרת Firebase.

AppDistributionExample/AppDelegate.swift

FirebaseApp.configure()

4. הגדרה של התראות על גרסאות חדשות באפליקציה באמצעות App Distribution SDK

בשלב הזה מוסיפים את Firebase App Distribution SDK לאפליקציה ומציגים בתוך האפליקציה התראות לטסטרים כשגרסאות חדשות של האפליקציה זמינות להתקנה. כדי לעשות זאת, מוודאים שהפעלתם את Firebase App Testers API בפרויקט Firebase Codelab (במסוף Google Cloud). תצטרכו להתחבר באמצעות אותו חשבון ולבחור את הפרויקט הנכון מהתפריט הנפתח בחלק העליון.

הגדרת התראות באפליקציה

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

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

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

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

  1. בודקת אם יש גרסאות חדשות שזמינות למשתתפי הבדיקה להתקנה. מחזירה אובייקט release או error.

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

בייבוא הקובץ AppDistributionViewController.swift ל-Firebase, בחלק העליון של הקובץ

AppDistributionViewController.swift

import Firebase

פותחים את AppDistributionExample/AppDistributionViewController.swift ומעתיקים את השורות לשיטה viewDidAppear כך:

AppDistributionViewController.swift

 override func viewDidAppear(_ animated: Bool) {
    checkForUpdate()
 }

עכשיו נטמיע את ה-method‏ checkForUpdate().

AppDistributionViewController.swift

  private func checkForUpdate() {
    AppDistribution.appDistribution().checkForUpdate(completion: { [self] release, error in
      var uiAlert: UIAlertController

      if error != nil {
        uiAlert = UIAlertController(title: "Error", message: "Error Checking for update! \(error?.localizedDescription ?? "")", preferredStyle: .alert)
      } else if release == nil {
        uiAlert = UIAlertController(title: "Check for Update", message: "No releases found!!", preferredStyle: .alert)
        uiAlert.addAction(UIAlertAction(title: "Ok", style: UIAlertAction.Style.default))
      } else {
        guard let release = release else { return }

        let title = "New Version Available"
        let message = "Version \(release.displayVersion)(\(release.buildVersion)) is available."
        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.present(uiAlert, animated: true, completion: nil)
    })
  }

5. יצירת האפליקציה והזמנת בודקים להוריד אותה

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

פיתוח האפליקציה

כשמוכנים להפיץ גרסת טרום-השקה של האפליקציה לבודקים, בוחרים באפשרות Any iOS Device (arm64)‎ (כל מכשיר iOS‏ (arm64)) כיעד ה-build, ואז באפשרות Product->Archive (מוצר -> ארכיון). אחרי שיוצרים את הארכיון, יוצרים הפצה חתומה באמצעות פרופיל הפצה של פיתוח.

98d8eb042c36a685.pngb2e9ccff91d761c1.png8e815564f64d2d39.png

בסיום ה-build, קובץ IPA וכמה קובצי יומן נשמרים בתיקייה שצוינה. כדי להפיץ את קובץ ה-IPA לבודקים, צריך לבצע את השלבים הבאים.

אם נתקלתם בבעיות בפיתוח האפליקציה, תוכלו להיעזר בשלבים לפתרון בעיות שמפורטים במסמכי החתימה של Apple.

הפצת האפליקציה לבודקים

כדי להפיץ את האפליקציה לבודקים, מעלים את קובץ ה-IPA באמצעות מסוף Firebase:

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

e4671bd304ecfe47.png

  1. בדף 'גרסאות', בוחרים את האפליקציה שרוצים להפיץ מהתפריט הנפתח.

8a3da2939b9746f4.png

  1. גוררים את קובץ ה-IPA של האפליקציה אל המסוף כדי להעלות אותו.
  2. אחרי שההעלאה מסתיימת, מציינים את קבוצות הבודקים ואת הבודקים האישיים שרוצים שיקבלו את הגרסה. (מוסיפים את כתובת האימייל כדי לקבל את ההזמנה). אחר כך מוסיפים נתוני גרסה ל-build. מידע נוסף על יצירת קבוצות בודקים זמין במאמר בנושא ניהול בודקים.

de63e3c3c64f909e.png

  1. לוחצים על 'הפצה' כדי שהגרסה תהיה זמינה לבודקים.

b6e75dc216fc3731.png

הוספת עצמכם כבודקים לגרסה

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

eb61c6be96ff3a11.png

מכיוון שציינת את כתובת האימייל שלך, תקבל הודעת אימייל מ-הפצת אפליקציות ב-Firebase עם הזמנה לבדוק את האפליקציה. עכשיו אתה הבודק הראשון! כדי להגדיר את עצמכם כבודקים במכשיר הבדיקה, ממשיכים לקטע הבא.

רישום מכשיר הבדיקה

כדי להוריד ולבדוק גרסת Ad Hoc, קודם צריך לרשום את מכשיר הבדיקה.

  1. במכשיר הבדיקה של iOS, פותחים את האימייל שנשלח מ-Firebase App Distribution ולוחצים על הקישור 'תחילת העבודה'. חשוב לפתוח את הקישור ב-Safari.
  2. באפליקציית האינטרנט של הפצת אפליקציות ב-Firebase לבודקים שמופיעה, נכנסים לחשבון Google ומקישים על אישור ההזמנה.

4d1af345ef944620.png

עכשיו תוכלו לראות את פריט התוכן שאליו הוזמנתם.

  1. מקישים על הרשמת המכשיר כדי לשתף את מזהה ה-UDID עם Firebase, וכך תוכלו לעדכן את פרופיל ההקצאה של האפליקציה מאוחר יותר.

fd141215e54a938d.png

  1. פועלים לפי ההוראות ועוברים להגדרות כדי להוריד את הפרופיל ולשתף את ה-UDID.

עכשיו, כשחוזרים אל הפצת אפליקציות, הגרסה מסומנת כ'המכשיר רשום':

fe93d649dfa25877.png

מספר ה-UDID של הבודק שותף עכשיו עם המפתח. עכשיו המפתח צריך ליצור גרסה חדשה של האפליקציה בשביל הבודק.

הצגת פרטי הבודקים במסוף

בתצוגה של המפתח במסוף Firebase, הבודק יופיע כ'אושר' בקטע 'גרסה':

1bef6f182c1c58f9.png

בנוסף, אם המכשיר שבו הם משתמשים לא נכלל כבר בפרופיל ההקצאה, תקבלו אימייל כמפתחים. כך תקבלו הודעה על ה-UDID החדש שצריך להוסיף. אפשר גם לייצא את כל מספרי ה-UDID כקובץ טקסט.

  1. כדי לייצא את כל מספרי ה-UDID, פותחים את הכרטיסייה 'בודקים וקבוצות'.

2745d49a6abc47fe.png

  1. לוחצים על 'ייצוא של מספרי UDID של מכשירי Apple'.

cb45477f8cc436ba.png

הקובץ צריך לכלול את מזהה המכשיר הייחודי (UDID) של מכשיר הבדיקה.

Device ID            Device Name                            Device Platform
1234567890     tester.app.distribtuion@gmail.com - iPhone SE 2nd Gen        ios

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

  1. מוסיפים את המכשירים לפורטל המפתחים של אפל.
  • אפשרות 1: ייבוא של מזהי המכשירים הייחודיים כקובץ CSV. בכרטיסייה 'בודקים וקבוצות' בלוח הבקרה של הפצת אפליקציות, בוחרים באפשרות 'כל הבודקים' ולוחצים על 'ייצוא של מספרי UDID של אפל' כדי להוריד קובץ CSV. לאחר מכן מייבאים את הקובץ אל חשבון הפיתוח של Apple באמצעות האפשרות Register Multiple Devices (רישום של כמה מכשירים). מידע נוסף זמין במאמרי העזרה של Apple. חשוב לדעת שייתכן שחשבון הפיתוח שלכם ב-Apple מאפשר לכם לייבא רק מספר מוגבל של מכשירים בשנה.
  • אפשרות 2: לאסוף את מספרי ה-UDID ולהזין אותם באימייל. בדף Add Devices בפורטל למפתחי אפל, רושמים את ה-UDID החדש שצוין באימייל שקיבלתם.

ffb74294e68ee1c8.png

  1. מוסיפים את המכשירים הרשומים לפרופיל ההקצאה.
  2. מורידים את פרופיל ההקצאה ומשתמשים בו כדי לבנות מחדש את האפליקציה. אם אתם בונים מחדש רק כדי לעדכן את המכשירים הרשומים, אל תעדכנו את מספר Build או הגרסה.
  3. מפיצים מחדש את האפליקציה ממסוף Firebase או מ-Firebase CLI. אם כבר הפצתם build עם אותו מספר Build וגרסה, רק משתמשים במכשירים שנרשמו לאחרונה יקבלו התראות באימייל.

הורדת הגרסה ממכשיר הבדיקה

עכשיו בגרסה יש את ה-UDID של מכשיר הבדיקה, כך שמכשיר הבדיקה יכול להוריד ולהתקין את האפליקציה. App Distribution שולח אימייל לבודקים כשה-UDID שלהם מתווסף לגרסה חדשה.

a4049260bae2850b.png

  1. במכשיר הבדיקה, חוזרים לאפליקציית האינטרנט של בודק הפצת האפליקציות באמצעות הקישור באימייל או הסמל במסך הבית של המכשיר.

כשעוברים לאפליקציה של ה-UDID codelab, אפשר לראות שהגרסה מוכנה להורדה.

dad6d03b6ad78746.png

  1. אם אתם משתמשים במכשיר פיזי, לוחצים על הורדה, ואז מתקינים ומפעילים את האפליקציה.
  2. כשהאפליקציה תופעל, תופיע בקשה להפעיל התראות על גרסאות חדשות. בוחרים באפשרות 'הפעלה'.

6e3540a2900734e6.png

  1. אחרי שתלחצו על הקישור, תתבקשו להיכנס לחשבון. לוחצים על 'המשך'.

82d90d7935bfaea0.png

  1. נכנסים באמצעות חשבון הבודק.

13bee1d03fa94ebf.png

  1. תועברו חזרה לאפליקציה ולא תצטרכו להיכנס או לאשר התראות בפעם הבאה שתפעילו את האפליקציה.

815d6757eb5f6327.png

הפצת עדכון לבודקים

  1. מעדכנים את מספר ה-build ל-2.

861aa63ebbc6ec54.png

  1. בוחרים באפשרות Any iOS Device (arm64) (כל מכשיר iOS‏ (arm64)) כיעד הבנייה, ואז באפשרות Product->Archive (מוצר -> ארכיון). אחרי שיוצרים את הארכיון, יוצרים הפצה חתומה באמצעות פרופיל הפצה של פיתוח.
  2. בסיום ה-build, קובץ IPA וכמה קובצי יומן נשמרים בתיקייה שצוינה. מעלים את קובץ ה-IPA החדש למסוף Firebase, מוסיפים שוב את כתובת האימייל שלכם כבודקים ומפיצים את האפליקציה.

b6e75dc216fc3731.png

התרעות על גרסת build לבדיקה

  1. אם האפליקציה פתוחה, סוגרים אותה. מפעילים מחדש את האפליקציה.
  2. כשמפעילים מחדש את האפליקציה, אמורה להתקבל התראה 'גרסה חדשה זמינה'.

3bd532992df458e6.png

  1. כדי לקבל את הגרסה העדכנית, לוחצים על 'עדכון'.
  2. במסך הבא, לוחצים על 'התקנה'.

3a761d8fa4b79d33.png

  1. כל הכבוד! הצלחת לעדכן את האפליקציה באמצעות ההתראות המובנות.

6. התאמה אישית של הכניסה של בודקים

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

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

נשבית את הבדיקה האוטומטית של העדכונים ב-viewDidAppear על ידי הוספת הערה לקריאה checkForUpdate().

AppDistributionViewController.swift

 override func viewDidAppear(_ animated: Bool) {
    // checkForUpdate()
 }

במקום זאת, נקרא ל-checkForUpdate() ב-checkForUpdateButtonClicked().

 @objc func checkForUpdateButtonClicked() {
    checkForUpdate()
 }

עכשיו נטמיע את השיטה signInOutButtonClicked() שתחבר את המשתמש לחשבון אם הוא לא מחובר, או תנתק אותו מהחשבון אם הוא כבר מחובר.

AppDistributionViewController.swift

 @objc func signInOutButtonClicked() {
    if isTesterSignedIn() {
      AppDistribution.appDistribution().signOutTester()

      self.configureCheckForUpdateButton()
      self.configureSignInSignOutButton()
      self.configureSignInStatus()

    } else {
      AppDistribution.appDistribution().signInTester(completion: { error in
        if error == nil {
          self.configureCheckForUpdateButton()
          self.configureSignInSignOutButton()
          self.configureSignInStatus()
        } else {
          let uiAlert = UIAlertController(title: "Custom:Error", message: "Error during tester sign in! \(error?.localizedDescription ?? "")", preferredStyle: .alert)
          uiAlert.addAction(UIAlertAction(title: "Ok", style: UIAlertAction.Style.default) {
            _ in
          })

          self.present(uiAlert, animated: true, completion: nil)
        }
      })
    }
  }

לבסוף, מטמיעים את ה-method‏ isTesterSignedIn.

AppDistributionViewController.swift

 private func isTesterSignedIn() -> Bool {
    return AppDistribution.appDistribution().isTesterSignedIn
 }

איך יוצרים את ההטמעה ובודקים אותה

7. כל הכבוד!

הטמעתם את התכונה 'הצגת התראות בתוך האפליקציה' באפליקציה באמצעות Firebase App Distribution iOS SDK.

מה נכלל

  • הפצת אפליקציות ב-Firebase
  • Firebase App Distribution New Alerts iOS SDK

השלבים הבאים

מידע נוסף

יש לך שאלה?

דיווח על בעיות