はじめに
Android アプリで Google API または Firebase サービスを有効にする際に、build.gradle
ファイルに google-services
プラグインを追加する必要があります。
dependencies {
classpath 'com.google.gms:google-services:4.4.2'
// ...
}
google-services
プラグインには、次の 2 つの主要な関数があります。
google-services.json
ファイルを処理し、アプリのコードで使用できる Android リソースを生成します。詳しくは、JSON ファイルを追加するをご覧ください。有効にしたサービスに必要な基本ライブラリの依存関係を追加します。この手順では、次のように Google サービスの Gradle プラグインを
app/build.gradle
ファイルに適用する必要があります。
apply plugin: 'com.google.gms.google-services'
このステップの結果を確認するには、
./gradlew :app:dependencies
を実行します。
JSON ファイルの追加
通常、google-services.json
ファイルは app/
ディレクトリ(Android Studio アプリ モジュールのルート)に配置されます。バージョン 2.2.0
では、このプラグインはビルドタイプとプロダクト フレーバー固有の JSON ファイルをサポートしています。次のディレクトリ構造はすべて有効です。
// dogfood and release are build types. app/ google-services.json src/dogfood/google-services.json src/release/google-services.json ...
注: google-services.json ファイルを release ディレクトリに提供することで、製品版 APK 用に別の Firebase プロジェクトを維持できます。
プロダクト フレーバーを使用している場合、このような複雑なディレクトリ構造も有効です。
// free and paid are product flavors. app/ google-services.json src/dogfood/paid/google-services.json src/release/free/google-services.json ...
JSON ファイルの処理
google-services.json
ファイルの基本構造は次のとおりです。
{ "project_info": {...}, "client": [...], }
project_info
オブジェクトにはプロジェクトに関する一般情報が含まれ、client
配列の各メンバーには、プロジェクトに追加したクライアント(Android アプリ)に関する情報が含まれます。
Android アプリの JSON ファイルを処理する場合、プラグインは以下のロジックに基づいて、(現在のビルドタイプの)パッケージ名と一致する client
オブジェクトのみを使用します。
client
配列のメンバーごとに次の操作を行います。client_info/android_client_info/package_name
の値を確認する- パッケージ名がこの値と一致する場合は、メンバー オブジェクトを返します。
client
のメンバーがパッケージ名に一致するものがない場合は、例外がスローされます。
このドキュメントの残りの部分では、{YOUR_CLIENT}
を使用して、上記の手順で決定された client
配列のメンバーを参照します。
JSON 処理の主な結果は、Java コード内で Android リソースとして参照できる 2 つの XML ファイルの生成です。各ファイルの例を次に示します。
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>
XML ファイル内のすべての値は、google-services.json
ファイルの以下の場所にあります。Android プロジェクトに google-services
プラグインを使用できない設定になっている場合は、下記の値を使用して XML ファイルを手動で安全に再作成できます。
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
トラブルシューティング
Q: ビルドすると、「File google-services.json is missing from module root folder. Google サービス プラグインは、これなしでは機能しません。」
A: google-services.json
は Firebase コンソールからダウンロードできます。また、ほとんどの API のクイックスタート ガイドに、このファイルの生成手順が記載されています。google-services.json
ファイルをダウンロードしたら、Android Studio プロジェクトの app/
フォルダにコピーします(複数のビルドタイプを使用している場合は app/src/{build_type}
フォルダにコピーします)。
Q: 記号「R.string.gcm_defaultSenderId」、「R.xml.global_tracker」などが見つかりません。
A: build.gradle
ファイルのパッケージ名が、google-services.json
ファイルの作成時に入力したパッケージ名と一致していることを確認してください。不明な場合は、スタートガイドのフローをもう一度実行し、新しい JSON ファイルを取得してください。