Das Gradle-Plug-in für Google-Dienste

Einführung

Wenn Sie Google APIs oder Firebase-Dienste in Ihrer Android-Anwendung aktivieren, müssen Sie möglicherweise das google-services-Plug-in zu Ihrer build.gradle-Datei hinzufügen:

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

Das google-services-Plug-in hat zwei Hauptfunktionen:

  1. Verarbeiten der Datei google-services.json und Erstellen von Android Ressourcen, die im Code Ihrer Anwendung verwendet werden können. Weitere Informationen finden Sie unter JSON-Datei hinzufügen.

  2. Hinzufügen von Abhängigkeiten für grundlegende Bibliotheken, die für die von Ihnen aktivierten Dienste erforderlich sind. Dazu müssen Sie das Google Services Gradle Plug-in in Ihrer app/build.gradle Datei anwenden, z. B. so:
    apply plugin: 'com.google.gms.google-services'

    Sie können das Ergebnis dieses Schritts mit ./gradlew :app:dependencies sehen.

JSON-Datei hinzufügen

Die Datei google-services.json wird in der Regel im Verzeichnis app/ (im Stammverzeichnis des Android Studio-App-Moduls) platziert. Ab Version 2.2.0 unterstützt das Plug-in JSON-Dateien, die für Build-Typen und Produktvarianten spezifisch sind. Alle folgenden Verzeichnisstrukturen sind gültig:

// dogfood and release are build types.
app/
    google-services.json
    src/dogfood/google-services.json
    src/release/google-services.json
    ...

Hinweis:Wenn Sie eine „google-services.json“-Datei im Release-Verzeichnis bereitstellen, können Sie ein separates Firebase-Projekt für Ihre Produktions-APKs verwenden.

Wenn Produktvarianten verwendet werden, sind auch diese komplizierteren Verzeichnisstrukturen gültig.

// free and paid are product flavors.
app/
    google-services.json
    src/dogfood/paid/google-services.json
    src/release/free/google-services.json
    ...

JSON-Datei verarbeiten

Die Datei google-services.json hat die folgende grundlegende Struktur:

{
  "project_info": {...},
  "client": [...],
}

Das Objekt project_info enthält allgemeine Informationen zu Ihrem Projekt. Jedes Mitglied des Arrays client enthält Informationen zu den Clients (Android-Apps), die Sie dem Projekt hinzugefügt haben.

Bei der Verarbeitung der JSON-Datei für Ihre Android-App verwendet das Plug-in nur das client-Objekt, das Ihrem Paketnamen entspricht (für den aktuellen Build-Typ). Dabei wird die folgende Logik verwendet:

  • Für jedes Mitglied des Arrays client:
    • Prüfen Sie den Wert von client_info/android_client_info/package_name.
    • Wenn der Paketname mit diesem Wert übereinstimmt, geben Sie das Mitgliedsobjekt zurück.
  • Wenn keiner der Mitglieder von client mit dem Paketnamen übereinstimmt, wird eine Ausnahme ausgelöst.

Im Rest dieses Dokuments verwenden wir {YOUR_CLIENT} für das Mitglied des Arrays client, das durch das oben beschriebene Verfahren bestimmt wird.

Das Hauptergebnis der JSON-Verarbeitung sind zwei XML-Dateien, auf die Sie in Ihrem Java-Code als Android-Ressourcen verweisen können. Hier sehen Sie ein Beispiel für jede Datei:

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>

Jeder Wert in den XML-Dateien ist in der Datei google-services.json an den folgenden Stellen vorhanden. Wenn Ihr Android-Projekt eine Konfiguration aufweist, die Sie an der Verwendung des google-services-Plug-ins hindert, können Sie die XML-Dateien mit diesen Werten manuell neu erstellen:

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

Fehlerbehebung

F: Beim Erstellen erhalte ich die folgende Fehlermeldung: „File google-services.json is missing from module root folder. The Google Services Plugin cannot function without it".

A: In der Firebase Console können Sie die Datei google-services.json herunterladen. Außerdem finden Sie in den Schnellstartanleitungen für die meisten APIs Anleitungen zum Generieren dieser Datei. Nachdem Sie die google-services.json Datei heruntergeladen haben, kopieren Sie sie in den app/ Ordner Ihres Android Studio-Projekts oder in den app/src/{build_type} Ordner, wenn Sie mehrere Build-Typen verwenden.

F: Ich kann das Symbol „R.string.gcm_defaultSenderId“, „R.xml.global_tracker“ usw. nicht finden.

A: Achten Sie darauf, dass der Paketname in Ihrer build.gradle-Datei mit dem Paketnamen übereinstimmt, den Sie beim Erstellen der Datei google-services.json eingegeben haben. Wenn Sie sich nicht sicher sind, führen Sie den Schnellstart noch einmal durch und rufen Sie eine neue JSON-Datei ab.