Einführung
Wenn Sie Google APIs oder Firebase-Dienste in Ihrer Android-Anwendung aktivieren möchten, müssen Sie der Datei build.gradle
möglicherweise das Plug-in google-services
hinzufügen:
dependencies {
classpath 'com.google.gms:google-services:4.4.2'
// ...
}
Das google-services
-Plug-in hat zwei Hauptfunktionen:
- Die
google-services.json
-Datei verarbeiten und Android-Ressourcen erstellen, 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 von Ihnen aktivierten Dienste erforderlich sind. Für diesen Schritt müssen Sie das Gradle-Plug-in für Google-Dienste in Ihrer
app/build.gradle
-Datei anwenden. Das sieht so aus:
apply plugin: 'com.google.gms.google-services'
Das Ergebnis dieses Schritts sehen Sie, wenn Sie
./gradlew :app:dependencies
ausführen.
JSON-Datei hinzufügen
Die Datei google-services.json
wird in der Regel im Verzeichnis app/
(im Stammverzeichnis des Android Studio-App-Moduls) abgelegt. Ab Version 2.2.0
unterstützt das Plug-in JSON-Dateien, die für den Buildtyp und die Produktvariante 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 verwalten.
Wenn Produktvarianten verwendet werden, sind auch diese komplexeren Verzeichnisstrukturen zulässig.
// 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 google-services.json
-Datei 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 anhand der folgenden Logik nur das client
-Objekt, das mit Ihrem Paketnamen (für den aktuellen Buildtyp) übereinstimmt:
- 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, gib das Mitgliedsobjekt zurück.
- Prüfen Sie den Wert von
- Wenn keines der Mitglieder von
client
mit dem Paketnamen übereinstimmt, wird eine Ausnahme ausgelöst.
Im Rest dieses Dokuments verwenden wir {YOUR_CLIENT}
als Verweis auf das Mitglied des client
-Arrays, das durch die oben beschriebene Prozedur ermittelt wurde.
Das Hauptergebnis der JSON-Verarbeitung sind zwei XML-Dateien, auf die Sie in Ihrem Java-Code als Android-Ressourcen verweisen können. Unten finden 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 an den folgenden Stellen in der google-services.json
-Datei vorhanden. Wenn Ihrem Android-Projekt eine Konfiguration fehlt, die die Verwendung des google-services
-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
F: Beim Erstellen wird die folgende Fehlermeldung angezeigt: „Die Datei google-services.json fehlt im Stammverzeichnis des Moduls. Das Google-Dienste-Plug-in funktioniert ohne dieses nicht.“
A: Über die Firebase Console können Sie die google-services.json
herunterladen.
Außerdem enthalten die Kurzanleitungen für die meisten APIs eine Anleitung zum Generieren dieser Datei.
Nachdem Sie die google-services.json
-Datei heruntergeladen haben, kopieren Sie sie in den Ordner app/
Ihres Android Studio-Projekts oder in den Ordner app/src/{build_type}
, wenn Sie mehrere Buildtypen verwenden.
F: Ich kann das Symbol „R.string.gcm_defaultSenderId“, „R.xml.global_tracker“ usw. nicht finden.
A: Der Paketname in der build.gradle
-Datei muss mit dem Paketnamen übereinstimmen, den Sie beim Erstellen der google-services.json
-Datei eingegeben haben. Wenn Sie sich nicht sicher sind, führen Sie den Einrichtungsvorgang noch einmal durch und erstellen Sie eine neue JSON-Datei.