Google-Dienste-Gradle-Plug-in und JSON-Konfigurationsdatei

Wenn Sie Ihrem Android-Projekt Firebase hinzufügen, müssen Sie das google-services-Gradle-Plug-in und eine google-services.json-Konfigurationsdatei zu Ihrem Projekt hinzufügen.

Wenn Sie Firebase Ihrem Android-Projekt über die Firebase-Konsole, die Management REST API oder die Firebase-CLI hinzufügen, müssen Sie das Gradle-Plug-in und die JSON-Konfigurationsdatei manuell zu Ihrem Projekt hinzufügen. Wenn Sie jedoch Firebase Assistant for Android Studio verwenden, werden diese Aufgaben automatisch bei der Einrichtung für Sie erledigt.

Gradle-Plug-in hinzufügen

Fügen Sie das Gradle-Plug-in der Google-Dienste (google-services) in Ihre build.gradle-Datei ein:

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

Das Gradle-Plug-in für Google-Dienste hat zwei Hauptfunktionen:

  • Verarbeitet die Konfigurationsdatei google-services.json und erstellt Android-Ressourcen, die im Code Ihrer App verwendet werden können.

  • Fügt Abhängigkeiten für grundlegende Bibliotheken hinzu, die für die von Ihnen aktivierten Dienste erforderlich sind. Für diesen Schritt müssen Sie das Gradle-Plug-in der Google-Dienste in Ihrer app/build.gradle-Datei anwenden, wie hier gezeigt:
    apply plugin: 'com.google.gms.google-services'

    Das Ergebnis dieses Schritts können Sie mit dem Befehl ./gradlew :app:dependencies sehen.

JSON-Konfigurationsdatei hinzufügen

Die Konfigurationsdatei google-services.json befindet sich in der Regel im Verzeichnis app/ (im Stammverzeichnis des Android Studio-App-Moduls). Ab Version 2.2.0 unterstützt das Plug-in Build-Typ- und Produktvarianten-spezifische JSON-Dateien. 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
    ...

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

So wird die JSON-Konfigurationsdatei verarbeitet

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

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

Das project_info-Objekt enthält allgemeine Informationen zu Ihrem Projekt. Jedes Mitglied des client-Arrays 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 (für den aktuellen Build-Typ) entspricht. Dabei wird die folgende Logik angewendet:

  • Für jedes Mitglied des client-Arrays prüft das Plug-in den Wert von client_info/android_client_info/package_name. Wenn der Paketname mit diesem Wert übereinstimmt, wird das Mitgliedsobjekt zurückgegeben.

  • Wenn keiner der Mitglieder von client mit dem Paketnamen übereinstimmt, löst das Plug-in eine Ausnahme aus.

Im Rest dieses Dokuments wird mit YOUR_CLIENT auf das Element des client-Arrays verwiesen, das durch die oben beschriebene Logik bestimmt wird.

Erstellung von XML-Dateien

Das Hauptergebnis der JSON-Verarbeitung sind zwei XML-Dateien, auf die Sie in Ihrem Code als Android-Ressourcen verweisen können. Im Folgenden finden Sie Beispiele für die einzelnen Dateien:

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

Werte in den XML-Dateien

Jeder Wert in den XML-Dateien ist in der Konfigurationsdatei google-services.json an den unten aufgeführten Stellen vorhanden. Wenn Ihr Android-Projekt eine Konfiguration hat, die die Verwendung des google-services-Gradle-Plug-ins verhindert, 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

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.

In der Firebase-Konsole können Sie die google-services.json-Konfigurationsdatei herunterladen.

Nachdem Sie die Konfigurationsdatei google-services.json heruntergeladen haben, kopieren Sie sie in den Ordner app/ Ihres Android Studio-Projekts oder in den Ordner app/src/{build_type}, wenn Sie mehrere Build-Typen verwenden.

Ich kann die Symbole wie R.string.gcm_defaultSenderId oder R.xml.global_tracker nicht finden.

Der Paketname in der Datei build.gradle muss mit dem Paketnamen übereinstimmen, den Sie beim Erstellen der Datei google-services.json eingegeben haben. Wenn Sie sich nicht sicher sind, führen Sie den Einstiegsprozess noch einmal durch und rufen Sie eine neue JSON-Datei ab.