מבוא
כחלק מההפעלה של שירותי Google APIs או Firebase באפליקציה ל-Android, יכול להיות שתצטרכו להוסיף את הפלאגין google-services
לקובץ build.gradle
:
dependencies {
classpath 'com.google.gms:google-services:4.4.2'
// ...
}
לפלאגין google-services
יש שתי פעולות עיקריות:
- מעבדים את הקובץ
google-services.json
ומפיקים משאבי Android שבהם אפשר להשתמש בקוד של האפליקציה. מידע נוסף זמין במאמר הוספת קובץ ה-JSON. מוסיפים יחסי תלות לספריות בסיסיות שנדרשות עבור השירותים שהפעלת. בשלב הזה צריך להחיל את הפלאגין של Google Services Gradle בקובץ
app/build.gradle
, כך:
apply plugin: 'com.google.gms.google-services'
כדי לראות את התוצאה של השלב הזה מריצים את
./gradlew :app:dependencies
.
הוספת קובץ ה-JSON
הקובץ google-services.json
בדרך כלל ממוקם בספרייה app/
(ברמה הבסיסית (root) של מודול האפליקציה ל-Android Studio). החל מגרסה 2.2.0
, הפלאגין תומך בקובצי JSON ספציפיים לסוג ה-build ולגרסת המוצר הספציפית. כל מבני הספריות הבאים תקינים:
// dogfood and release are build types. app/ google-services.json src/dogfood/google-services.json src/release/google-services.json ...
הערה: הוספת קובץ google-services.json בספריית הגרסאות מאפשרת לנהל פרויקט נפרד של Firebase ל-APKs בסביבת הייצור.
כשמשתמשים בטעמים של מוצרים, גם מבני הספריות המורכבים יותר האלה חוקיים.
// free and paid are product flavors. app/ google-services.json src/dogfood/paid/google-services.json src/release/free/google-services.json ...
עיבוד קובץ ה-JSON
לקובץ google-services.json
יש את המבנה הבסיסי הבא:
{ "project_info": {...}, "client": [...], }
האובייקט project_info
מכיל מידע כללי על הפרויקט, וכל חבר במערך client
מכיל מידע על הלקוחות (אפליקציות ל-Android) שהוספתם לפרויקט.
כשמעבדים את קובץ ה-JSON באפליקציה ל-Android, הפלאגין משתמש רק באובייקט client
שתואם לשם החבילה (לסוג ה-build הנוכחי) לפי הלוגיקה הבאה:
- לכל איבר במערך
client
:- יש לבדוק את הערך של
client_info/android_client_info/package_name
- אם שם החבילה תואם לערך הזה, מוחזר אובייקט המנוי.
- יש לבדוק את הערך של
- אם אף אחד מחברי הקבוצה
client
לא תואם לשם החבילה, המערכת תירשם חריג.
בהמשך המסמך נשתמש ב-{YOUR_CLIENT}
כדי להתייחס לאיבר במערך client
שנקבע באמצעות התהליך שלמעלה.
התוצאה העיקרית של עיבוד ה-JSON היא להפיק שני קובצי XML שאפשר להתייחס אליהם כמשאבי Android בקוד Java. לפניכם דוגמה לכל קובץ:
app/build/generated/res/google-services/{build_type}/values/values.xml
<?xml version="1.0" encoding="utf-8"?> <resources> <! -- Present in all applications --> <string name="google_app_id" translatable="false">1:1035469437089:android:73a4fb8297b2cd4f</string> <! -- Present in applications with the appropriate services configured --> <string name="gcm_defaultSenderId" translatable="false">1035469437089</string> <string name="default_web_client_id" translatable="false">337894902146-e4uksm38sne0bqrj6uvkbo4oiu4hvigl.apps.googleusercontent.com</string> <string name="ga_trackingId" translatable="false">UA-65557217-3</string> <string name="firebase_database_url" translatable="false">https://example-url.firebaseio.com</string> <string name="google_api_key" translatable="false">AIzbSyCILMsOuUKwN3qhtxrPq7FFemDJUAXTyZ8</string> <string name="google_crash_reporting_api_key" translatable="false">AIzbSyCILMsOuUKwN3qhtxrPq7FFemDJUAXTyZ8</string> <string name="project_id" translatable="false">mydemoapp</string> </resources>
app/build/generated/res/google-services/{flavor}/{build_type}/xml/global_tracker.xml
<?xml version="1.0" encoding="utf-8"?> <resources> <string name="ga_trackingId" translatable="false">UA-65557218-3</string> </resources>
כל ערך בקובצי ה-XML נמצא בקובץ google-services.json
במיקומים שלמטה. אם בפרויקט Android שלכם יש הגדרות מסוימות שמונעות מכם להשתמש בפלאגין google-services
, אפשר ליצור מחדש את קובצי ה-XML באופן ידני באמצעות הערכים הבאים:
google_app_id:
{YOUR_CLIENT}/client_info/mobilesdk_app_id
gcm_defaultSenderId:
project_info/project_number
default_web_client_id:
{YOUR_CLIENT}/oauth_client/client_id (client_type == 3)
ga_trackingId:
{YOUR_CLIENT}/services/analytics-service/analytics_property/tracking_id
firebase_database_url:
project_info/firebase_url
google_api_key:
{YOUR_CLIENT}/api_key/current_key
google_crash_reporting_api_key:
{YOUR_CLIENT}/api_key/current_key
project_id:
project_info/project_id
פתרון בעיות
שאלה: כשהבניין מקבל את הודעת השגיאה הבאה: "הקובץ google-services.json חסר בתיקיית הבסיס של המודול. הפלאגין של שירותי Google לא יכול לפעול בלעדיו".
תשובה: מסוף Firebase יעזור לכם להוריד את google-services.json
.
בנוסף, במדריכים למתחילים לרוב ממשקי ה-API יש הוראות ליצירת הקובץ הזה.
אחרי שמורידים את הקובץ google-services.json
, מעתיקים אותו לתיקייה app/
בפרויקט ב-Android Studio, או לתיקייה app/src/{build_type}
אם משתמשים בכמה סוגי build.
ש: לא ניתן למצוא את הסמל "R.string.gcm_defaultSenderId ", "R.xml.global_tracker" וכו'.
תשובה: מוודאים ששם החבילה בקובץ build.gradle
תואם לשם החבילה שהזנתם כשיצרתם את הקובץ google-services.json
. אם אתם לא בטוחים, תוכלו להריץ שוב את התהליך לתחילת העבודה ולקבל קובץ json חדש.