Wtyczka Gradle usług Google

Wprowadzenie

W ramach włączania interfejsów API Google lub usług Firebase na urządzeniu z Androidem konieczne może być dodanie wtyczki google-services do Plik build.gradle:

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

Wtyczka google-services ma 2 główne funkcje:

1. Przetwarzaj plik google-services.json i twórz Androida zasobów, których można użyć w w kodzie. Więcej informacji znajdziesz w sekcji Dodawanie pliku JSON.

2. Dodaj zależności podstawowych bibliotek wymaganych przez używane usługi . Ten krok wymaga zastosowania Gradle usług Google w pliku app/build.gradle w następujący sposób:
   apply plugin: 'com.google.gms.google-services'

   Aby zobaczyć efekt tego kroku, uruchom polecenie ./gradlew :app:dependencies

Dodawanie pliku JSON

Plik google-services.json zazwyczaj znajduje się w sekcji app/ (w katalogu głównym modułu aplikacji Android Studio). Jako wersji 2.2.0 wtyczka obsługuje typ kompilacji i rodzaj produktu określonych plików JSON. Wszystkie te struktury katalogów są prawidłowe:

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

Uwaga: udostępnienie pliku google-services.json w katalogu wersji umożliwia utrzymanie osobnego projektu Firebase na produkcyjne pakiety APK.

Jeśli używane są różne rodzaje produktów, bardziej skomplikowane struktury katalogów również prawidłowe.

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

Przetwarzanie pliku JSON

Plik google-services.json ma taką podstawową strukturę:

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

Obiekt project_info zawiera ogólne informacje o projektu, a każdy element tablicy client zawiera informacje o klientach (aplikacjach na Androida) dodanych do projektu.

Podczas przetwarzania pliku JSON Twojej aplikacji na Androida wtyczka korzysta tylko z makra client obiekt pasujący do nazwy pakietu (na potrzeby bieżącej kompilacji typ) na podstawie tej logiki:

• Dla każdego elementu tablicy client:
  • Sprawdź wartość kolumny client_info/android_client_info/package_name
  • Jeśli nazwa pakietu pasuje do tej wartości, zwraca obiekt elementu.
• Jeśli żaden z elementów grupy client nie pasuje do nazwy pakietu, zgłaszany jest wyjątek.

W pozostałej części tego dokumentu {YOUR_CLIENT} będziemy używać jako określenia element tablicy client określonej w powyższej procedurze.

Głównym wynikiem przetwarzania JSON jest wygenerowanie dwóch plików XML, mogą się odnosić do zasobów Androida w kodzie Java. Oto przykład: każdy plik:

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>

Wszystkie wartości w plikach XML znajdują się w pliku google-services.json w poniższych lokalizacjach. Jeśli Twój projekt na Androida ma jakąś konfigurację uniemożliwia korzystanie z wtyczki google-services, możesz bezpiecznie odtworzyć pliki XML ręcznie przy użyciu następujących wartości:

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

Rozwiązywanie problemów

P. Podczas kompilacji pojawia się komunikat o błędzie: „Plik W folderze głównym modułu brakuje pliku google-services.json. Usługi Google Bez niej wtyczka nie może działać”.

O: Konsola Firebase pomoże Ci pobierz google-services.json. Ponadto w przewodnikach szybkiego startu dotyczących większości interfejsów API znajdują się instrukcje dotyczące podczas jego generowania. Gdy pobierzesz plik google-services.json, skopiuj go w folderze app/ projektu Android Studio lub app/src/{build_type}, jeśli używasz różnych typów kompilacji.

Pyt.: Nie mogę znaleźć symbolu „R.string.gcm_defaultSenderId”. „R.xml.global_tracker” itp.

O: Upewnij się, że nazwa pakietu w pliku build.gradle jest zgodna z nazwą nazwa pakietu podana podczas tworzenia elementu google-services.json . Jeśli nie masz pewności, powtórz czynności dotyczące rozpoczynania pracy i nowy plik JSON.