הוספת Firebase לפרויקט Android

דרישות מוקדמות

  • מתקינים את Android Studio או מעדכנים אותו לגרסה האחרונה.

  • צריך לוודא שהפרויקט עומד בדרישות האלה (שימו לב שלחלק מהמוצרים יש דרישות מחמירות יותר):

    • מטרגטת לרמת API‏ 21 (Lollipop) ומעלה
    • מכשיר Android מגרסה 5.0 ואילך
    • האפליקציה משתמשת ב-Jetpack (AndroidX), שכולל את דרישות הגרסה הבאות:
      • ‫com.android.tools.build:gradle גרסה 7.3.0 ואילך
      • ‫compileSdkVersion 28 ואילך

  • מגדירים מכשיר פיזי או משתמשים באמולטור כדי להריץ את האפליקציה.
    שימו לב: כדי להשתמש ב-Firebase SDKs עם תלות בשירותי Google Play, צריך להתקין את שירותי Google Play במכשיר או באמולטור.

  • נכנסים ל-Firebase באמצעות חשבון Google.

אם עדיין אין לכם פרויקט Android ואתם רק רוצים לנסות מוצר של Firebase, אתם יכולים להוריד אחד מהדוגמאות שלנו להפעלה מהירה.


אפשר לקשר את אפליקציית Android ל-Firebase באחת מהדרכים הבאות:

  • אפשרות 1: (מומלץ) שימוש בתהליך ההגדרה של Firebase המסוף.
  • אפשרות 2: שימוש ב-Firebase Assistant ב-Android Studio (יכול להיות שתידרש הגדרה נוספת).


אפשרות 1: הוספת Firebase באמצעות מסוף Firebase

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

שלב 1: יצירת פרויקט Firebase

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

שלב 2: רישום האפליקציה ב-Firebase

כדי להשתמש ב-Firebase באפליקציית Android, צריך לרשום את האפליקציה בפרויקט Firebase. רישום האפליקציה נקרא לעיתים קרובות "הוספה" של האפליקציה לפרויקט.

  1. עוברים אל מסוף Firebase.

  2. במרכז הדף 'סקירת הפרויקט', לוחצים על הסמל Android () או על הוספת אפליקציה כדי להפעיל את תהליך ההגדרה.

  3. מזינים את שם החבילה של האפליקציה בשדה שם החבילה של Android.

  4. (אופציונלי) מזינים פרטים נוספים על האפליקציה: כינוי לאפליקציה ואישור חתימה לניפוי באגים SHA-1.

  5. לוחצים על רישום האפליקציה.

שלב 3: מוסיפים קובץ הגדרות של Firebase

  1. מורידים את קובץ התצורה של Firebase (google-services.json) של האפליקציה ומוסיפים אותו לבסיס הקוד:

    1. לוחצים על הורדת google-services.json כדי לקבל את קובץ התצורה של Firebase של האפליקציה.

    2. מעבירים את קובץ ההגדרות אל ספריית השורש של המודול (ברמת האפליקציה) של האפליקציה.

  2. כדי שהערכים בקובץ ההגדרות google-services.json יהיו נגישים ל-Firebase SDKs, צריך את Google services Gradle plugin ‏(google-services).

    1. בקובץ Gradle ברמת השורש (ברמת הפרויקט) (<project>/build.gradle.kts או <project>/build.gradle), מוסיפים את הפלאגין של שירותי Google כתלות:

      Kotlin 

      plugins {
  id("com.android.application") version "7.3.0" apply false
  // ...

  // Add the dependency for the Google services Gradle plugin
  id("com.google.gms.google-services") version "4.4.3" apply false
}

      Groovy 

      plugins {
  id 'com.android.application' version '7.3.0' apply false
  // ...

  // Add the dependency for the Google services Gradle plugin
  id 'com.google.gms.google-services' version '4.4.3' apply false
}

    2. בקובץ Gradle של המודול (ברמת האפליקציה) (בדרך כלל <project>/<app-module>/build.gradle.kts או <project>/<app-module>/build.gradle), מוסיפים את הפלאגין של שירותי Google:

      Kotlin 

      plugins {
  id("com.android.application")

  // Add the Google services Gradle plugin
  id("com.google.gms.google-services")
  // ...
}

      Groovy 

      plugins {
  id 'com.android.application'

  // Add the Google services Gradle plugin
  id 'com.google.gms.google-services'
  // ...
}

שלב 4: מוסיפים את Firebase SDKs לאפליקציה

  1. בקובץ Gradle של המודול (ברמת האפליקציה) (בדרך כלל <project>/<app-module>/build.gradle.kts או <project>/<app-module>/build.gradle), מוסיפים את יחסי התלות של מוצרי Firebase שרוצים להשתמש בהם באפליקציה. מומלץ להשתמש ב-Firebase Android BoM כדי לשלוט בניהול הגרסאות של הספרייה.

    Analytics הופעלו 

    dependencies {
  // ...

  // Import the Firebase BoM
  implementation(platform("com.google.firebase:firebase-bom:34.0.0"))

  // When using the BoM, you don't specify versions in Firebase library dependencies

  // Add the dependency for the Firebase SDK for Google Analytics
  implementation("com.google.firebase:firebase-analytics")

  // TODO: Add the dependencies for any other Firebase products you want to use
  // See https://firebase.google.com/docs/android/setup#available-libraries
  // For example, add the dependencies for Firebase Authentication and Cloud Firestore
  implementation("com.google.firebase:firebase-auth")
  implementation("com.google.firebase:firebase-firestore")
}

    באמצעות התגית Firebase Android BoM, האפליקציה תמיד תשתמש בגרסאות תואמות של ספריות Firebase ל-Android.

    Analytics לא מופעל 

    dependencies {
  // ...

  // Import the Firebase BoM
  implementation(platform("com.google.firebase:firebase-bom:34.0.0"))

  // When using the BoM, you don't specify versions in Firebase library dependencies

  // TODO: Add the dependencies for Firebase products you want to use
  // See https://firebase.google.com/docs/android/setup#available-libraries
  // For example, add the dependencies for Firebase Authentication and Cloud Firestore
  implementation("com.google.firebase:firebase-auth")
  implementation("com.google.firebase:firebase-firestore")
}

    באמצעות התגית Firebase Android BoM, האפליקציה תמיד תשתמש בגרסאות תואמות של ספריות Firebase ל-Android.

  2. אחרי שמוסיפים את יחסי התלות של המוצרים שרוצים להשתמש בהם, מסנכרנים את פרויקט Android עם קובצי Gradle.

זהו זה! אפשר לדלג קדימה כדי לעיין בשלבים הבאים המומלצים.

אם נתקלתם בבעיות בהגדרה, מומלץ לעיין בשאלות הנפוצות ובפתרון הבעיות ב-Android.


אפשרות 2: הוספת Firebase באמצעות Firebase Assistant

העוזר של Firebase רושם את האפליקציה שלכם בפרויקט Firebase ומוסיף את הקבצים, הפלאגינים והתלויות הדרושים של Firebase לפרויקט Android – והכול מתוך Android Studio!

  1. פותחים את פרויקט Android ב-Android Studio ומוודאים שמשתמשים בגרסאות העדכניות של Android Studio ושל Firebase Assistant:

    • Windows / Linux: עזרה > בדיקה אם יש עדכונים
    • ‫macOS: ‏ Android Studio > Check for updates (בדיקת עדכונים)

  2. פותחים את Firebase Assistant: כלים > Firebase.

  3. בחלונית העזרה, בוחרים מוצר של Firebase שרוצים להוסיף לאפליקציה. מרחיבים את הקטע שלו ולוחצים על הקישור למדריך (לדוגמה, Analytics > תיעוד אירוע ב-Analytics).

    1. לוחצים על Connect to Firebase (קישור אל Firebase) כדי לקשר את פרויקט Android אל Firebase.

    2. לוחצים על הלחצן כדי להוסיף את מוצר Firebase הרצוי (לדוגמה, הוספת Analytics לאפליקציה).

  4. מסנכרנים את האפליקציה כדי לוודא שלכל הרכיבים התלויים יש את הגרסאות הנדרשות.

  5. בחלונית העוזר, פועלים לפי שאר הוראות ההגדרה של מוצר Firebase שבחרתם.

  6. אפשר להוסיף כמה מוצרי Firebase שרוצים באמצעות Firebase Assistant.

זהו זה! חשוב לעיין בשלבים הבאים המומלצים.

אם נתקלתם בבעיות בהגדרה, מומלץ לעיין בשאלות הנפוצות ובפתרון הבעיות ב-Android.


ספריות זמינות

בקטע הזה מפורטים מוצרי Firebase שנתמכים ב-Android והתלויות שלהם ב-Gradle. מידע נוסף על ספריות Firebase Android האלה:

הערה: כשמשתמשים ב-Firebase Android BoM, לא מציינים גרסאות ספציפיות של ספריות כשמצהירים על תלות בספריית Firebase בקובץ ההגדרות של Gradle.

שירות או מוצר תלות ב-Gradle הגרסה
העדכנית		 להוסיף את Analytics?
Firebase Android BoM
(Bill of Materials)		 com.google.firebase:firebase-bom

גרסה Firebase BoM כוללת את הגרסאות העדכניות ביותר של כל ספריית Firebase Android. כדי לדעת אילו גרסאות של הספרייה ממופות לגרסה ספציפית של BoM, צריך לעיין בהערות לגבי הגרסה של BoM.

 34.0.0
AdMob com.google.android.gms:play-services-ads 24.4.0
Firebase AI Logic 1 com.google.firebase:firebase-ai ‫17.0.0
Analytics com.google.firebase:firebase-analytics 23.0.0
App Check ספק בהתאמה אישית com.google.firebase:firebase-appcheck ‫19.0.0
App Check ספק ניפוי באגים com.google.firebase:firebase-appcheck-debug ‫19.0.0
App Check ספק Play Integrity com.google.firebase:firebase-appcheck-playintegrity ‫19.0.0
App Distribution com.google.firebase:firebase-appdistribution ‫16.0.0-beta16
‫App Distribution API com.google.firebase:firebase-appdistribution-api ‫16.0.0-beta16
App Distribution plugin com.google.firebase:firebase-appdistribution-gradle 5.1.1
Authentication com.google.firebase:firebase-auth 24.0.0
Cloud Firestore com.google.firebase:firebase-firestore ‫26.0.0
Cloud Functions for Firebase Client SDK com.google.firebase:firebase-functions ‫22.0.0
Cloud Messaging com.google.firebase:firebase-messaging ‫25.0.0
Cloud Storage com.google.firebase:firebase-storage ‫22.0.0
Crashlytics com.google.firebase:firebase-crashlytics ‫20.0.0
‫Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk ‫20.0.0
Crashlytics plugin com.google.firebase:firebase-crashlytics-gradle 3.0.5
Data Connect com.google.firebase:firebase-dataconnect ‫17.0.0
תמיכה במודולים של תכונות דינמיות com.google.firebase:firebase-dynamic-module-support ‫16.0.0-beta04
Dynamic Links com.google.firebase:firebase-dynamic-links ‫22.1.0
In-App Messaging com.google.firebase:firebase-inappmessaging ‫22.0.0
(חובה)
In-App Messaging רשת המדיה com.google.firebase:firebase-inappmessaging-display ‫22.0.0
(חובה)
Firebase התקנות com.google.firebase:firebase-installations ‫19.0.0
‫Firebase ML Model Downloader API com.google.firebase:firebase-ml-modeldownloader ‫26.0.0
Performance Monitoring com.google.firebase:firebase-perf ‫22.0.0
Performance Monitoring plugin com.google.firebase:perf-plugin 2.0.0
Realtime Database com.google.firebase:firebase-database ‫22.0.0
Remote Config com.google.firebase:firebase-config 23.0.0
תוסף של שירותי Google Play com.google.gms:google-services ‫4.4.3
ספריות שיצאו משימוש
App Check ספק SafetyNet com.google.firebase:firebase-appcheck-safetynet 16.1.2
App Indexing com.google.firebase:firebase-appindexing ‫20.0.0

מודולים של Firebase KTX

Analytics com.google.firebase:firebase-analytics-ktx 22.5.0
App Check ספק בהתאמה אישית com.google.firebase:firebase-appcheck-ktx ‫18.0.0
‫App Distribution API com.google.firebase:firebase-appdistribution-api-ktx ‫16.0.0-beta15
Authentication com.google.firebase:firebase-auth-ktx ‫23.2.1
Cloud Firestore com.google.firebase:firebase-firestore-ktx ‫25.1.4
Cloud Functions for Firebase Client SDK com.google.firebase:firebase-functions-ktx ‫21.2.1
Cloud Messaging com.google.firebase:firebase-messaging-ktx ‫24.1.2
Cloud Storage com.google.firebase:firebase-storage-ktx ‫21.0.2
Crashlytics com.google.firebase:firebase-crashlytics-ktx ‫19.4.4
Dynamic Links com.google.firebase:firebase-dynamic-links-ktx ‫22.1.0
In-App Messaging com.google.firebase:firebase-inappmessaging-ktx ‫21.0.2
(חובה)
In-App Messaging רשת המדיה com.google.firebase:firebase-inappmessaging-display-ktx ‫21.0.2
(חובה)
Firebase התקנות com.google.firebase:firebase-installations-ktx ‫18.0.0
‫Firebase ML Model Downloader API com.google.firebase:firebase-ml-modeldownloader-ktx ‫25.0.1
Performance Monitoring com.google.firebase:firebase-perf-ktx 21.0.5
Realtime Database com.google.firebase:firebase-database-ktx ‫21.0.0
Remote Config com.google.firebase:firebase-config-ktx ‫22.1.2

ספריות Firebase ML Kit

Firebase ML ממשקי API של מודלים בהתאמה אישית com.google.firebase:firebase-ml-model-interpreter 22.0.4
‫Firebase ML Vision APIs com.google.firebase:firebase-ml-vision 24.1.0
‫Firebase ML: מודל לתוויות של תמונות com.google.firebase:firebase-ml-vision-image-label-model 20.0.2
‫Firebase ML: מודל לזיהוי ולמעקב אחר אובייקטים com.google.firebase:firebase-ml-vision-object-detection-model ‫19.0.6
‫Firebase ML: מודל לזיהוי פנים com.google.firebase:firebase-ml-vision-face-model 20.0.2
‫Firebase ML: מודל לסריקת ברקודים com.google.firebase:firebase-ml-vision-barcode-model 16.1.2
‫Firebase ML: AutoML Vision Edge API com.google.firebase:firebase-ml-vision-automl ‫18.0.6
‫Firebase ML: Natural Language APIs com.google.firebase:firebase-ml-natural-language ‫22.0.1
‫Firebase ML: מודל לזיהוי שפה com.google.firebase:firebase-ml-natural-language-language-id-model 20.0.8
‫Firebase ML: Translate Model com.google.firebase:firebase-ml-natural-language-translate-model 20.0.9
Firebase ML: מודל תשובה מהירה com.google.firebase:firebase-ml-natural-language-smart-reply-model 20.0.8

‫1 Firebase AI Logic נקרא בעבר 'Vertex AI in Firebase' עם החבילה com.google.firebase:firebase-vertexai.


השלבים הבאים

מוסיפים שירותי Firebase לאפליקציה:

  • יצירת תכונות מבוססות-AI גנרטיבי באמצעות מודלים של Gemini ו-Imagen באמצעות Firebase AI Logic.

  • קבלת תובנות לגבי התנהגות המשתמשים באמצעות Analytics.

  • מגדירים תהליך אימות משתמש באמצעות Authentication.

  • שמירת נתונים, כמו פרטי משתמש, באמצעות Cloud Firestore או Realtime Database.

  • אחסון קבצים, כמו תמונות וסרטונים, באמצעות Cloud Storage.

  • הפעלת קוד backend שפועל בסביבה מאובטחת באמצעות Cloud Functions.

  • שליחת התראות באמצעות Cloud Messaging.

  • כדי לגלות מתי ולמה האפליקציה קורסת, אפשר להשתמש ב-Crashlytics.

מידע על Firebase