Google サービス Gradle プラグインと JSON 構成ファイル

Firebase を Android プロジェクトに追加する一環として、プロジェクトに google-services Gradle プラグインと google-services.json 構成ファイルを追加する必要があります。

Firebase コンソール、Management REST API、Firebase CLI を使用して Firebase を Android プロジェクトに追加する場合は、Gradle プラグインと JSON 構成ファイルを手動でプロジェクトに追加する必要があります。ただし、Firebase Assistant for Android Studio を使用する場合、これらのタスクは設定時に自動的に実行されます。

Gradle プラグインを追加する

build.gradle ファイルに Google サービス Gradle プラグイン（google-services）を追加します。

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

Google サービス Gradle プラグインには、主に次の 2 つの機能があります。

  • google-services.json 構成ファイルを処理し、アプリのコードで使用できる Android リソースを生成します。

  • 有効にしたサービスに必要な基本ライブラリの依存関係を追加します。このステップでは、次のように app/build.gradle ファイルで Google サービスの 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
    ...

プロダクト フレーバーが使用されている場合、より複雑なディレクトリ構造も有効です。

// 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 のメンバーのいずれもパッケージ名と一致しない場合、プラグインは例外をスローします。

このドキュメントの残りの部分では、上記のロジックで決定される client 配列のメンバーを参照するために YOUR_CLIENT を使用します。

XML ファイルの作成

JSON 処理の主な結果は、コードで 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 ファイル内の値

XML ファイルのすべての値は、以下の場所にある google-services.json 構成ファイルに存在します。Android プロジェクトに google-services Gradle プラグインの使用を妨げる構成がある場合は、これらの値を使用して 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

トラブルシューティング

ビルド時に、次のエラー メッセージが表示されます: File google-services.json is missing from module root folder. The Google Services Plugin cannot function without it。

Firebase コンソールを使用すると、google-services.json 構成ファイルをダウンロードできます。

google-services.json 構成ファイルをダウンロードしたら、Android Studio プロジェクトの app/ フォルダにコピーします。複数のビルドタイプを使用している場合は、app/src/{build_type} フォルダにコピーします。

R.string.gcm_defaultSenderId や R.xml.global_tracker などの記号が見つかりません。

build.gradle ファイルのパッケージ名が、google-services.json ファイルの作成時に入力したパッケージ名と一致していることを確認します。不明な場合は、スタートガイドの手順をもう一度実行して、新しい JSON ファイルを取得してください。