Google サービス Gradle プラグイン

はじめに

Android で Google API や Firebase サービスを有効にする手順 使用する場合は、google-services プラグインを build.gradle ファイル:

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

google-services プラグインには、次の 2 つの主要な関数があります。

  1. google-services.json ファイルを処理して Android を生成する アプリケーションで使用可能なリソースを できます。詳しくは、JSON ファイルを追加するをご覧ください。
  2. 使用するサービスに必要な基本ライブラリの依存関係を追加する 有効にします。このステップでは、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 配列のメンバーごとに、次のコマンドを実行します。 <ph type="x-smartling-placeholder">
      </ph>
    • client_info/android_client_info/package_name の値を確認する
    • パッケージ名がこの値と一致する場合は、メンバー オブジェクトを返します。
  • client のメンバーがパッケージ名に一致するものがない場合は、例外がスローされます。

このドキュメントの残りの部分では、{YOUR_CLIENT} を使用して以下を参照します。 上記の手順で確定した client 配列のメンバー。

JSON 処理の主な結果は、次の 2 つの XML ファイルを生成することです。 Java コード内で Android リソースとして参照できます。以下に例を示します。 :

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 がありません。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 の作成時に入力したパッケージ名 表示されます。判断に迷う場合は、開始フローをもう一度行ってから 作成します