このページは Cloud Translation API によって翻訳されました。

Google サービス Gradle プラグイン

はじめに

Android アプリで Google API または Firebase サービスを有効にする場合、build.gradle ファイルに google-services プラグインを追加する必要があります。

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

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 ファイルを提供すると、本番環境の 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: Firebase コンソールを使用すると google-services.json をダウンロードできます。また、ほとんどの 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 ファイルを取得します。