הפלאגין של Google Services Gradle

מבוא

כחלק מהפעלת ממשקי Google API או שירותי Firebase באפליקציה ל-Android, יכול להיות שתצטרכו להוסיף את הפלאגין google-services לקובץ build.gradle:

dependencies {
    classpath 'com.google.gms:google-services:4.4.2'
    // ...
}

לפלאגין google-services יש שתי פונקציות עיקריות:

1. עיבוד הקובץ google-services.json וייצור משאבי Android שאפשר להשתמש בהם בקוד של האפליקציה. מידע נוסף זמין בקטע הוספת קובץ ה-JSON.

2. מוסיפים יחסי תלות לספריות בסיסיות שנדרשות לשירותים שהפעלתם. בשלב הזה צריך להחיל את הפלאגין של Google Services ל-Gradle בקובץ app/build.gradle, כך:
   apply plugin: 'com.google.gms.google-services'

   כדי לראות את התוצאה של השלב הזה, מריצים את הפקודה ./gradlew :app:dependencies.

הוספת קובץ ה-JSON

קובץ google-services.json ממוקם בדרך כלל בתיקייה app/ (בספריית הבסיס של מודול האפליקציה ל-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 נפרד לקובצי ה-APK שלכם בסביבת הייצור.

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

// 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

פתרון בעיות

שאלה: כשאני מבצע build, מופיעה הודעת השגיאה הבאה: "File google-services.json is missing from module root folder. הפלאגין של שירותי 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 חדש.