ปลั๊กอิน Google Services Gradle

ข้อมูลเบื้องต้น

ในการเปิดใช้บริการ Google API หรือ Firebase ในแอปพลิเคชัน Android คุณอาจต้องเพิ่มปลั๊กอิน google-services ลงในไฟล์ build.gradle โดยทําดังนี้

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

ปลั๊กอิน google-services มีการทํางานหลัก 2 อย่าง ได้แก่

1. ประมวลผลไฟล์ google-services.json และสร้างทรัพยากรของ Android ที่สามารถใช้ในโค้ดของแอปพลิเคชันได้ โปรดดูการเพิ่มไฟล์ JSON สําหรับข้อมูลเพิ่มเติม

2. เพิ่มทรัพยากร Dependency สําหรับไลบรารีพื้นฐานที่จําเป็นสําหรับบริการที่คุณเปิดใช้ ในขั้นตอนนี้ คุณต้องใช้ปลั๊กอิน 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 รสเฉพาะของผลิตภัณฑ์ โครงสร้างไดเรกทอรีต่อไปนี้ทั้งหมดถูกต้อง

// 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 ที่ตรงกับชื่อแพ็กเกจ (สําหรับประเภทบิลด์ปัจจุบัน) ตามตรรกะต่อไปนี้

• สําหรับสมาชิกแต่ละรายของอาร์เรย์ client:
  • ตรวจสอบค่าของ client_info/android_client_info/package_name
  • ถ้าชื่อแพ็กเกจตรงกับค่านี้ ให้แสดงผลออบเจ็กต์สมาชิก
• หากไม่มีสมาชิกใน client ที่ตรงกับชื่อแพ็กเกจ ระบบจะยกเว้นข้อยกเว้น

สําหรับส่วนที่เหลือของเอกสารนี้ เราจะใช้ {YOUR_CLIENT} เพื่ออ้างถึงสมาชิกของอาร์เรย์ client ที่กําหนดโดยขั้นตอนด้านบน

ผลหลักของการประมวลผล JSON คือการสร้างไฟล์ XML 2 ไฟล์ที่ใช้อ้างอิงเป็นทรัพยากร 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:

{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} หากคุณใช้บิลด์หลายประเภท

ถาม: ฉันไม่พบสัญลักษณ์ "R.string.gcm_defaultSenderId", "R.xml.global_tracker" ฯลฯ

ตอบ: ตรวจสอบว่าชื่อแพ็กเกจในไฟล์ build.gradle ตรงกับชื่อแพ็กเกจที่คุณป้อนเมื่อสร้างไฟล์ google-services.json ถ้าคุณไม่แน่ใจ ให้เรียกใช้ขั้นตอนการเริ่มต้นใช้งานอีกครั้งและรับไฟล์ json ใหม่