Einführung
Wenn Sie Google APIs oder Firebase-Dienste in Ihrer Android-App aktivieren, müssen Sie der Datei build.gradle
möglicherweise das Plug-in google-services
hinzufügen:
dependencies {
classpath 'com.google.gms:google-services:4.3.15'
// ...
}
Das google-services
-Plug-in hat zwei Hauptfunktionen:
- Verarbeiten Sie die Datei
google-services.json
und erstellen Sie Android-Ressourcen, die im Code Ihrer Anwendung verwendet werden können. Weitere Informationen finden Sie unter JSON-Datei hinzufügen. Fügen Sie Abhängigkeiten für grundlegende Bibliotheken hinzu, die für die aktivierten Dienste erforderlich sind. Für diesen Schritt musst du das Gradle-Plug-in für Google-Dienste in deiner
app/build.gradle
-Datei so anwenden:
apply plugin: 'com.google.gms.google-services'
Sie können das Ergebnis dieses Schritts sehen, indem Sie
./gradlew :app:dependencies
ausführen.
JSON-Datei hinzufügen
Die Datei google-services.json
wird normalerweise im Verzeichnis app/
(Stammverzeichnis des Android Studio-App-Moduls) abgelegt. Ab Version 2.2.0
unterstützt das Plug-in spezifische JSON-Dateien für Build-Typen und Produktvarianten. Die 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 Releaseverzeichnis angeben, können Sie ein separates Firebase-Projekt für Ihre Produktions-APKs verwalten.
Wenn Produktaromen 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 Grundstruktur:
{ "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 gemäß der folgenden Logik nur das Objekt client
, das Ihrem Paketnamen (für den aktuellen Build-Typ) entspricht:
- Für jedes Mitglied des
client
-Arrays gilt Folgendes:- Wert von
client_info/android_client_info/package_name
prüfen - Wenn der Paketname mit diesem Wert übereinstimmt, wird das Mitgliedsobjekt zurückgegeben.
- Wert von
- Wenn keines der Mitglieder von
client
mit dem Paketnamen übereinstimmt, wird eine Ausnahme ausgelöst.
Für den Rest dieses Dokuments verwenden wir {YOUR_CLIENT}
, um auf das Mitglied des Arrays client
zu verweisen, das im obigen Verfahren festgelegt wurde.
Das Hauptergebnis der JSON-Verarbeitung ist die Erstellung von zwei XML-Dateien, auf die Sie in Ihrem Java-Code als Android-Ressourcen verweisen können. Hier 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 Speicherorten vorhanden. Wenn Ihr Android-Projekt eine Konfiguration hat, die die Verwendung des Plug-ins google-services
verhindert, können Sie die XML-Dateien mit diesen Werten sicher 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: „Die Datei „google-services.json“ fehlt im Modulstammordner. Ohne dieses Plug-in funktioniert das Google-Dienste-Plug-in nicht.“
A: Über die Firebase Console können Sie google-services.json
herunterladen.
Außerdem finden Sie in den Kurzanleitungen für die meisten APIs eine Anleitung zum Generieren dieser Datei.
Nachdem Sie die Datei 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.
F: Ich kann das Symbol „R.string.gcm_defaultSenderId“, „R.xml.global_tracker“ usw. nicht finden.
A: Der Paketname in der Datei build.gradle
muss mit dem Namen übereinstimmen, den Sie beim Erstellen der Datei google-services.json
eingegeben haben. Wenn Sie sich nicht sicher sind, führen Sie noch einmal den Startleitfaden durch und erhalten Sie eine neue JSON-Datei.