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

前提条件

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

  • プロジェクトが次の要件を満たしていることを確認します（プロダクトによっては、より厳しい要件がある場合があります）。

    • API レベル 21（Lollipop）以降を対象としていること
    • Android 5.0 以上を使用していること。
    • Jetpack（AndroidX）を使用します。また、次のバージョン要件を満たしている必要があります。
      • com.android.tools.build:gradle v7.3.0 以降
      • compileSdkVersion 28 以降

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

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

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


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

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


オプション 1: Firebase コンソールを使用して Firebase を追加する

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

ステップ 1: Firebase プロジェクトを作成する

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

ステップ 2: アプリを Firebase に登録する

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

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

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

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

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

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

ステップ 3: Firebase 構成ファイルを追加する

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

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

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

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

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

      Kotlin 

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

  // Add the dependency for the Google services Gradle plugin
  id("com.google.gms.google-services") version "4.4.2" apply false
}

      Groovy 

      plugins {
  id 'com.android.application' version '7.3.0' apply false
  // ...

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

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

      Kotlin 

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

  // Add the Google services Gradle plugin
  id("com.google.gms.google-services")
  // ...
}

      Groovy 

      plugins {
  id 'com.android.application'

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

ステップ 4: アプリに Firebase SDK を追加する

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

    Analytics　有効化

    dependencies {
  // ...

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

  // 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 BoM を使用すると、アプリは常に互換性のあるバージョンの Firebase Android ライブラリを使用します。

    Kotlin 固有のライブラリ モジュールをお探しの場合、2023 年 10 月（Firebase BoM 32.5.0）以降、Kotlin と Java のどちらのデベロッパーもメイン ライブラリ モジュールを利用できるようになります（詳しくは、このイニシアチブに関するよくある質問をご覧ください）。

    Analytics　無効 

    dependencies {
  // ...

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

  // 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 BoM を使用すると、アプリは常に互換性のあるバージョンの Firebase Android ライブラリを使用します。

    Kotlin 固有のライブラリ モジュールをお探しの場合、2023 年 10 月（Firebase BoM 32.5.0）以降、Kotlin と Java のどちらのデベロッパーもメイン ライブラリ モジュールを利用できるようになります（詳しくは、このイニシアチブに関するよくある質問をご覧ください）。

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

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

設定の際に問題が発生した場合は、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 に接続します。

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

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

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

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

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

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


使用可能なライブラリ

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

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

サービスまたはプロダクト Gradle 依存関係 最新
バージョン		 Analytics を追加？
Firebase Android BoM
(Bill of Materials)		 com.google.firebase:firebase-bom

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

 33.9.0
AdMob com.google.android.gms:play-services-ads 23.6.0
Analytics com.google.firebase:firebase-analytics 22.2.0
App Check カスタム プロバイダ com.google.firebase:firebase-appcheck 18.0.0
App Check デバッグ プロバイダ com.google.firebase:firebase-appcheck-debug 18.0.0
App Check Play Integrity プロバイダ com.google.firebase:firebase-appcheck-playintegrity 18.0.0
App Distribution com.google.firebase:firebase-appdistribution 16.0.0-beta14
App Distribution API com.google.firebase:firebase-appdistribution-api 16.0.0-beta14
App Distribution プラグイン com.google.firebase:firebase-appdistribution-gradle 5.1.1
Authentication com.google.firebase:firebase-auth 23.2.0
Cloud Firestore com.google.firebase:firebase-firestore 25.1.2
Cloud Functions for Firebase Client SDK com.google.firebase:firebase-functions 21.1.0
Cloud Messaging com.google.firebase:firebase-messaging 24.1.0
Cloud Storage com.google.firebase:firebase-storage 21.0.1
Crashlytics com.google.firebase:firebase-crashlytics 19.4.0
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 19.4.0
Crashlytics プラグイン com.google.firebase:firebase-crashlytics-gradle 3.0.3
動的機能モジュールのサポート com.google.firebase:firebase-dynamic-module-support 16.0.0-beta03
Dynamic Links com.google.firebase:firebase-dynamic-links 22.1.0
In-App Messaging com.google.firebase:firebase-inappmessaging 21.0.1
（必須）
In-App Messaging Display com.google.firebase:firebase-inappmessaging-display 21.0.1
（必須）
Firebaseインストール com.google.firebase:firebase-installations 18.0.0
Firebase ML Model Downloader API com.google.firebase:firebase-ml-modeldownloader 25.0.1
Performance Monitoring com.google.firebase:firebase-perf 21.0.4
Performance Monitoring プラグイン com.google.firebase:perf-plugin 1.4.2
Realtime Database com.google.firebase:firebase-database 21.0.0
Remote Config com.google.firebase:firebase-config 22.1.0
Vertex AI in Firebase com.google.firebase:firebase-vertexai 16.1.0
Google Play 開発者サービス プラグイン com.google.gms:google-services 4.4.2
非推奨ライブラリ
App Check SafetyNet プロバイダ com.google.firebase:firebase-appcheck-safetynet 16.1.2
App Indexing com.google.firebase:firebase-appindexing 20.0.0

Firebase KTX モジュール

Analytics com.google.firebase:firebase-analytics-ktx 22.2.0
App Check カスタム プロバイダ com.google.firebase:firebase-appcheck-ktx 18.0.0
App Distribution API com.google.firebase:firebase-appdistribution-api-ktx 16.0.0-beta14
Authentication com.google.firebase:firebase-auth-ktx 23.2.0
Cloud Firestore com.google.firebase:firebase-firestore-ktx 25.1.2
Cloud Functions for Firebase Client SDK com.google.firebase:firebase-functions-ktx 21.1.0
Cloud Messaging com.google.firebase:firebase-messaging-ktx 24.1.0
Cloud Storage com.google.firebase:firebase-storage-ktx 21.0.1
Crashlytics com.google.firebase:firebase-crashlytics-ktx 19.4.0
Dynamic Links com.google.firebase:firebase-dynamic-links-ktx 22.1.0
In-App Messaging com.google.firebase:firebase-inappmessaging-ktx 21.0.1
（必須）
In-App Messaging Display com.google.firebase:firebase-inappmessaging-display-ktx 21.0.1
（必須）
Firebaseインストール com.google.firebase:firebase-installations-ktx 18.0.0
Firebase ML Model Downloader API com.google.firebase:firebase-ml-modeldownloader-ktx 25.0.1
Performance Monitoring com.google.firebase:firebase-perf-ktx 21.0.4
Realtime Database com.google.firebase:firebase-database-ktx 21.0.0
Remote Config com.google.firebase:firebase-config-ktx 22.1.0

Firebase ML Kit ライブラリ

Firebase ML Custom Model 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 の詳細を確認します。