Android プロジェクトに Firebase を追加する

  • Android Studio の最新バージョンをインストールするか、更新します。

  • プロジェクトが次の要件を満たしていることを確認します。

    • ターゲットが API レベル 19（KitKat）以上であること。
    • Android 4.4 以上を使用していること。
    • Jetpack（AndroidX）を使用していること。次のバージョン要件を満たしている必要があります。
      • com.android.tools.build:gradle v3.2.1 以降
      • compileSdkVersion 28 以降

  • 実機を設定するか、エミュレータを使用してアプリを実行します。
    Google Play 開発者サービスに依存している Firebase SDK を使用する場合、デバイスまたはエミュレータに Google Play 開発者サービスがインストールされている必要があります。

  • Google アカウントを使用して Firebase にログインします。

Android プロジェクトがまだない方で Firebase プロダクトを試す場合は、クイックスタート サンプルをダウンロードしてください。


Android アプリは以下のいずれかの方法で Firebase に接続できます。

  • オプション 1: （推奨）Firebase コンソールの設定ワークフローを使用します。
  • オプション 2: Android Studio Firebase Assistant を使用します（追加構成が必要な場合があります）。


Firebase をアプリに追加するには、Firebase コンソールと開いている Android プロジェクトの両方でタスクを行う必要があります（コンソールから Firebase 構成ファイルをダウンロードし、Android プロジェクトに移動するなど）。

Android アプリに Firebase を追加する前に、Android アプリに接続するための Firebase プロジェクトを作成します。Firebase プロジェクトの詳細については、Firebase プロジェクトについて理解するをご覧ください。

  1. Firebase コンソールで [プロジェクトを追加] をクリックします。

    • Firebase リソースを既存の Google Cloud プロジェクトに追加するには、そのプロジェクト名を入力するか、プルダウン メニューから選択します。

    • 新しいプロジェクトを作成するには、任意のプロジェクト名を入力します。必要に応じて、プロジェクト名の下に表示されるプロジェクト ID を編集することもできます。

  2. Firebase の利用規約が表示されたら、内容を読み、同意します。

  3. [続行] をクリックします。

  4. （省略可）プロジェクトに対し Google アナリティクスを設定します。これにより、次の Firebase プロダクトを使用する際のエクスペリエンスを最適化できます。

    既存の Google アナリティクス アカウントを選択するか、新しいアカウントを作成します。

    新しいアカウントを作成する場合は、アナリティクス レポートのロケーションを選択し、プロジェクトのデータ共有設定と Google アナリティクスの規約に同意します。

  5. [プロジェクトを作成]（既存の Google Cloud プロジェクトを使用する場合は [Firebase を追加]）をクリックします。

Firebase プロジェクトのリソースが自動的にプロビジョニングされます。処理が完了すると、Firebase コンソールに Firebase プロジェクトの概要ページが表示されます。

Android アプリで Firebase を使用するには、アプリを Firebase プロジェクトに登録する必要があります。アプリの登録は、プロジェクトへのアプリの「追加」とも呼ばれます。

  1. Firebase コンソールに移動します。

  2. プロジェクトの概要ページの中央で、Android アイコン（）または [アプリを追加] をクリックして、設定ワークフローを起動します。

  3. [Android パッケージ名] フィールドにアプリのパッケージ名を入力します。

    • パッケージ名は、デバイスと Google Play ストアでアプリを一意に識別するものです。

    • パッケージ名はアプリケーション ID と呼ばれることもあります。

    • モジュール（アプリレベル）の Gradle ファイルでアプリのパッケージ名を探します。通常は app/build.gradle です（例: com.yourcompany.yourproject）。

    • パッケージ名の値は大文字と小文字が区別されます。Firebase プロジェクトに登録された後、この Firebase Android アプリのパッケージ名は変更できないことに注意してください。

  4. （省略可）その他のアプリ情報（アプリのニックネームとデバッグ用の署名証明書 SHA-1）を入力します。

  5. [アプリを登録] をクリックします。

  1. Firebase Android 構成ファイル（google-services.json）をダウンロードしてアプリに追加します。

    1. [Download google-services.json] をクリックして、Firebase Android 構成ファイルを入手します。

    2. 構成ファイルをアプリのモジュール（アプリレベル）ルート ディレクトリに移動します。

    • Firebase 構成ファイルには、プロジェクト用の機密ではない一意の識別子が含まれています。この構成ファイルの詳細については、Firebase プロジェクトについて理解するをご覧ください。

    • Firebase 構成ファイルはいつでも再ダウンロードできます。

    • 構成ファイル名に (2) などの文字が追加されていないことを確認します。

  2. google-services.json 構成ファイルの値に Firebase SDK からアクセスできるようにするには、Google サービスの Gradle プラグイン（google-services）が必要です。

    1. ルートレベル（プロジェクト レベル）の Gradle ファイル（<project>/build.gradle.kts または <project>/build.gradle）で、依存関係として Google サービス プラグインを追加します。

      KotlinGroovy
       
      plugins {
        id      ("com.android.application") version "7.2.0" apply false
              // ...

              // Add the dependency for the Google services Gradle plugin
        id      ("com.google.gms.google-services") version "4.3.15" apply false
      }
      plugins {
        id       'com.android.application' version '7.2.0' apply false
              // ...

              // Add the dependency for the Google services Gradle plugin
        id       'com.google.gms.google-services' version '4.3.15' apply false
      }

    2. モジュール（アプリレベル）の Gradle ファイル（通常は <project>/<app-module>/build.gradle.kts または <project>/<app-module>/build.gradle）に、Google サービス プラグインを追加します。

      KotlinGroovy
       
      plugins {
        id      ("com.android.application")

              // Add the Google services Gradle plugin
        id      ("com.google.gms.google-services")
              // ...
      }
      plugins {
        id       'com.android.application'

              // Add the Google services Gradle plugin
        id       'com.google.gms.google-services'
              // ...
      }

  1. モジュール（アプリレベル）の Gradle ファイル（通常は <project>/build.gradle.kts または <project>/build.gradle）で、アプリで使用する Firebase プロダクトの依存関係を追加します。Firebase Android 部品構成表を使用して、ライブラリのバージョニングを管理することをおすすめします。

    アナリティクスが有効な場合アナリティクスが無効な場合
    Kotlin+KTXJava
     
    dependencies {
          // ...

          // Import the Firebase BoM
      implementation    (platform("com.google.firebase:firebase-bom:32.3.1"))

          // When using the BoM, you don't specify versions in Firebase library dependencies

          // Add the dependency for the Firebase SDK for Google Analytics
          implementation("com.google.firebase:firebase-analytics-ktx")

          // TODO: Add the dependencies for any other Firebase products you want to use
          // See https://firebase.google.com/docs/android/setup#available-libraries
          // For example, add the dependencies for Firebase Authentication and Cloud Firestore
      implementation    ("com.google.firebase:firebase-auth-ktx")
      implementation    ("com.google.firebase:firebase-firestore-ktx")
    }
    dependencies {
          // ...

          // Import the Firebase BoM
      implementation    (platform("com.google.firebase:firebase-bom:32.3.1"))

          // When using the BoM, you don't specify versions in Firebase library dependencies

          // Add the dependency for the Firebase SDK for Google Analytics
          implementation("com.google.firebase:firebase-analytics")

          // TODO: Add the dependencies for any other Firebase products you want to use
          // See https://firebase.google.com/docs/android/setup#available-libraries
          // For example, add the dependencies for Firebase Authentication and Cloud Firestore
      implementation    ("com.google.firebase:firebase-auth")
      implementation    ("com.google.firebase:firebase-firestore")
    }

    Firebase Android 部品構成表を使用すると、アプリは互換性のあるバージョンの Firebase Android ライブラリを常に使用します。

    Kotlin+KTXJava
     
    dependencies {
          // ...

          // Import the Firebase BoM
      implementation    (platform("com.google.firebase:firebase-bom:32.3.1"))

          // When using the BoM, you don't specify versions in Firebase library dependencies

          // TODO: Add the dependencies for Firebase products you want to use
          // See https://firebase.google.com/docs/android/setup#available-libraries
          // For example, add the dependencies for Firebase Authentication and Cloud Firestore
      implementation    ("com.google.firebase:firebase-auth-ktx")
      implementation    ("com.google.firebase:firebase-firestore-ktx")
    }
    dependencies {
          // ...

          // Import the Firebase BoM
      implementation    (platform("com.google.firebase:firebase-bom:32.3.1"))

          // When using the BoM, you don't specify versions in Firebase library dependencies

          // TODO: Add the dependencies for Firebase products you want to use
          // See https://firebase.google.com/docs/android/setup#available-libraries
          // For example, add the dependencies for Firebase Authentication and Cloud Firestore
      implementation    ("com.google.firebase:firebase-auth")
      implementation    ("com.google.firebase:firebase-firestore")
    }

    Firebase Android 部品構成表を使用すると、アプリは互換性のあるバージョンの Firebase Android ライブラリを常に使用します。

  2. 使用するプロダクトの依存関係を追加したら、Android プロジェクトを Gradle ファイルと同期します。

    Android Gradle プラグイン（AGP）v4.2 以前を使用する Gradle ビルドでは、Java 8 サポートを有効にする必要があります。そうしないと、Firebase SDK を追加した際に Android プロジェクトでビルドエラーが発生します。

    このビルドエラーを修正するには、次の 2 つの方法があります。

    • エラー メッセージに示されている compileOptions をアプリレベルの build.gradle.kts ファイルまたは build.gradle ファイルに追加します。
    • Android プロジェクトの minSdk を 26 以上に設定します。

    このビルドエラーの詳細については、こちらのよくある質問をご覧ください。

これで、推奨の次の手順に進めます。

設定の際に問題が発生した場合は、Android のトラブルシューティングとよくある質問をご覧ください。


オプション 2: Firebase Assistant を使用して Firebase を追加する

Firebase Assistant は、Firebase プロジェクトにアプリを登録し、Android プロジェクトに必要な Firebase ファイル、プラグイン、依存関係を追加します。これらはすべて Android Studio から行えます。

  1. Android Studio で Android プロジェクトを開き、Android Studio と Firebase Assistant の最新版を使用していることを確認します。

    • Windows / Linux: [Help] > [Check for updates]
    • macOS: [Android Studio] > [Check for updates]

  2. Firebase Assistant を開きます（[Tools] > [Firebase]）。

  3. [Assistant] ペインで、アプリに追加する Firebase プロダクトを選択します。セクションを展開し、チュートリアルのリンク（[Analytics] > [Log an Analytics event] など）をクリックします。

    1. [Connect to Firebase] をクリックして Android プロジェクトを Firebase に接続します。

      • このワークフローは、アプリのパッケージ名を使用して新しい Firebase Android アプリを自動的に作成します。この新しい Firebase Android アプリは、既存の Firebase プロジェクトと新しいプロジェクトのどちらでも作成できます。

        Firebase プロジェクトの設定については、次のヒントを参考にしてください。

        • Firebase プロジェクトにアプリを追加する際のベスト プラクティス（複数のバリアントの扱い方など）をご確認ください。

        • 新しいプロジェクトを作成する場合は、プロジェクトで Google アナリティクスを設定することを強くおすすめします。これにより、多くの Firebase プロダクトで最適なエクスペリエンスを実現できます。

      • また、このワークフローでは、Firebase プロジェクトの Android 構成ファイル（google-services.json）をアプリのモジュール（アプリレベル）ディレクトリに追加します。

    2. ボタンをクリックして、必要な Firebase プロダクトを追加します（アプリにアナリティクスを追加するなど）。

  4. アプリを同期して、すべての依存関係に必要なバージョンがあることを確認します。

  5. [Assistant] ペインで、選択した Firebase プロダクトの残りの設定手順を行います。

  6. Firebase Assistant で、他にも多くの Firebase プロダクトを追加できます。

これで、推奨の次の手順に進めます。

設定の際に問題が発生した場合は、Android のトラブルシューティングとよくある質問をご覧ください。


使用可能なライブラリ

このセクションでは、Android とその Gradle 依存関係でサポートされている Firebase プロダクトを一覧表示しています。Firebase Android ライブラリの詳細については、以下をご覧ください。

Firebase Android BoM を使用する場合、Gradle のビルド構成ファイルで Firebase ライブラリの依存関係を宣言する際に、個々のライブラリ バージョンを指定しません。

Kotlin+KTXJava
サービスまたはプロダクト Gradle 依存関係 最新
バージョン		 アナリティクスの追加
Firebase Android BoM
（部品構成表）		 com.google.firebase:firebase-bom

最新バージョンの Firebase BoM には、各 Firebase Android ライブラリの最新バージョンが含まれます。特定の BoM バージョンにマッピングされているライブラリ バージョンを確認するには、その BoM バージョンのリリースノートをご覧ください。

 32.3.1
AdMob com.google.android.gms:play-services-ads 22.4.0
アナリティクス com.google.firebase:firebase-analytics-ktx 21.3.0
App Check カスタム プロバイダ com.google.firebase:firebase-appcheck-ktx 17.0.1
App Check デバッグ プロバイダ com.google.firebase:firebase-appcheck-debug 17.0.1
App Check Play Integrity プロバイダ com.google.firebase:firebase-appcheck-playintegrity 17.0.1
App Distribution com.google.firebase:firebase-appdistribution 16.0.0-beta10
App Distribution API com.google.firebase:firebase-appdistribution-api-ktx 16.0.0-beta10
App Distribution プラグイン com.google.firebase:firebase-appdistribution-gradle 4.0.0
Authentication com.google.firebase:firebase-auth-ktx 22.1.2
Cloud Firestore com.google.firebase:firebase-firestore-ktx 24.8.1
Cloud Functions for Firebase のクライアント SDK com.google.firebase:firebase-functions-ktx 20.3.1
Cloud Messaging com.google.firebase:firebase-messaging-ktx 23.2.1
Cloud Storage com.google.firebase:firebase-storage-ktx 20.2.1
Crashlytics com.google.firebase:firebase-crashlytics-ktx 18.4.3
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 18.4.3
Crashlytics プラグイン com.google.firebase:firebase-crashlytics-gradle 2.9.9
動的機能モジュールのサポート com.google.firebase:firebase-dynamic-module-support 16.0.0-beta03
Dynamic Links com.google.firebase:firebase-dynamic-links-ktx 21.1.0
In-App Messaging com.google.firebase:firebase-inappmessaging-ktx 20.3.5
（必須）
In-App Messaging Display com.google.firebase:firebase-inappmessaging-display-ktx 20.3.5
（必須）
Firebase インストール com.google.firebase:firebase-installations-ktx 17.1.4
Firebase ML Model Downloader API com.google.firebase:firebase-ml-modeldownloader-ktx 24.1.3
Performance Monitoring com.google.firebase:firebase-perf-ktx 20.4.1
Performance Monitoring プラグイン com.google.firebase:perf-plugin 1.4.2
Realtime Database com.google.firebase:firebase-database-ktx 20.2.2
Remote Config com.google.firebase:firebase-config-ktx 21.4.1
Google Play 開発者サービス プラグイン com.google.gms:google-services 4.3.15
非推奨ライブラリ
App Check SafetyNet プロバイダ com.google.firebase:firebase-appcheck-safetynet 16.1.2
App Indexing com.google.firebase:firebase-appindexing 20.0.0
Firebase ML カスタムモデル API com.google.firebase:firebase-ml-model-interpreter 22.0.4
Firebase ML Vision API com.google.firebase:firebase-ml-vision 24.1.0
Firebase ML: 画像ラベル付けモデル com.google.firebase:firebase-ml-vision-image-label-model 20.0.2
Firebase ML: オブジェクトの検出とトラッキング モデル com.google.firebase:firebase-ml-vision-object-detection-model 19.0.6
Firebase ML: 顔検出モデル com.google.firebase:firebase-ml-vision-face-model 20.0.2
Firebase ML: バーコード スキャンモデル com.google.firebase:firebase-ml-vision-barcode-model 16.1.2
Firebase ML: AutoML Vision Edge API com.google.firebase:firebase-ml-vision-automl 18.0.6
Firebase ML: Natural Language API com.google.firebase:firebase-ml-natural-language 22.0.1
Firebase ML: 言語識別モデル com.google.firebase:firebase-ml-natural-language-language-id-model 20.0.8
Firebase ML: 翻訳モデル com.google.firebase:firebase-ml-natural-language-translate-model 20.0.9
Firebase ML: スマート リプライモデル com.google.firebase:firebase-ml-natural-language-smart-reply-model 20.0.8
サービスまたはプロダクト Gradle 依存関係 最新
バージョン		 アナリティクスの追加
Firebase Android BoM
（部品構成表）		 com.google.firebase:firebase-bom

最新バージョンの Firebase BoM には、各 Firebase Android ライブラリの最新バージョンが含まれます。特定の BoM バージョンにマッピングされているライブラリ バージョンを確認するには、その BoM バージョンのリリースノートをご覧ください。

 32.3.1
AdMob com.google.android.gms:play-services-ads 22.4.0
アナリティクス com.google.firebase:firebase-analytics 21.3.0
App Check カスタム プロバイダ com.google.firebase:firebase-appcheck 17.0.1
App Check デバッグ プロバイダ com.google.firebase:firebase-appcheck-debug 17.0.1
App Check Play Integrity プロバイダ com.google.firebase:firebase-appcheck-playintegrity 17.0.1
App Distribution com.google.firebase:firebase-appdistribution 16.0.0-beta10
App Distribution API com.google.firebase:firebase-appdistribution-api 16.0.0-beta10
App Distribution プラグイン com.google.firebase:firebase-appdistribution-gradle 4.0.0
Authentication com.google.firebase:firebase-auth 22.1.2
Cloud Firestore com.google.firebase:firebase-firestore 24.8.1
Cloud Functions for Firebase のクライアント SDK com.google.firebase:firebase-functions 20.3.1
Cloud Messaging com.google.firebase:firebase-messaging 23.2.1
Cloud Storage com.google.firebase:firebase-storage 20.2.1
Crashlytics com.google.firebase:firebase-crashlytics 18.4.3
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 18.4.3
Crashlytics プラグイン com.google.firebase:firebase-crashlytics-gradle 2.9.9
動的機能モジュールのサポート com.google.firebase:firebase-dynamic-module-support 16.0.0-beta03
Dynamic Links com.google.firebase:firebase-dynamic-links 21.1.0
In-App Messaging com.google.firebase:firebase-inappmessaging 20.3.5
（必須）
In-App Messaging Display com.google.firebase:firebase-inappmessaging-display 20.3.5
（必須）
Firebase インストール com.google.firebase:firebase-installations 17.1.4
Firebase ML Model Downloader API com.google.firebase:firebase-ml-modeldownloader 24.1.3
Performance Monitoring com.google.firebase:firebase-perf 20.4.1
Performance Monitoring プラグイン com.google.firebase:perf-plugin 1.4.2
Realtime Database com.google.firebase:firebase-database 20.2.2
Remote Config com.google.firebase:firebase-config 21.4.1
Google Play 開発者サービス プラグイン com.google.gms:google-services 4.3.15
非推奨ライブラリ
App Check SafetyNet プロバイダ com.google.firebase:firebase-appcheck-safetynet 16.1.2
App Indexing com.google.firebase:firebase-appindexing 20.0.0
Firebase ML カスタムモデル API com.google.firebase:firebase-ml-model-interpreter 22.0.4
Firebase ML Vision API com.google.firebase:firebase-ml-vision 24.1.0
Firebase ML: 画像ラベル付けモデル com.google.firebase:firebase-ml-vision-image-label-model 20.0.2
Firebase ML: オブジェクトの検出とトラッキング モデル com.google.firebase:firebase-ml-vision-object-detection-model 19.0.6
Firebase ML: 顔検出モデル com.google.firebase:firebase-ml-vision-face-model 20.0.2
Firebase ML: バーコード スキャンモデル com.google.firebase:firebase-ml-vision-barcode-model 16.1.2
Firebase ML: AutoML Vision Edge API com.google.firebase:firebase-ml-vision-automl 18.0.6
Firebase ML: Natural Language API com.google.firebase:firebase-ml-natural-language 22.0.1
Firebase ML: 言語識別モデル com.google.firebase:firebase-ml-natural-language-language-id-model 20.0.8
Firebase ML: 翻訳モデル com.google.firebase:firebase-ml-natural-language-translate-model 20.0.9
Firebase ML: スマート リプライモデル com.google.firebase:firebase-ml-natural-language-smart-reply-model 20.0.8


次のステップ

Firebase サービスをアプリに追加します。

以下で Firebase の詳細を確認します。