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 を使用します（追加構成が必要な場合があります）。

オプション 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 アイコン（plat_android）または [アプリを追加] をクリックして、設定ワークフローを起動します。

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

   パッケージ名とは何ですか？どこで見つけられますか？

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

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

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

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

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

   Firebase 内でアプリのニックネームとデバッグ用の署名証明書 SHA-1 はどのように使用されますか？

   • アプリのニックネーム: 内部用の簡易的な ID であり、Firebase コンソールでのみ表示されます。

   • デバッグ用の署名証明書 SHA-1: SHA-1 ハッシュは Firebase Authentication（Google ログインまたは電話番号ログインを使用する場合）と Firebase Dynamic Links で必要です。

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

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

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）で、buildscript の依存関係として Google サービス プラグインを追加します。

      buildscript {
      
          repositories {
            // Make sure that you have the following two repositories
            google()  // Google's Maven repository
            mavenCentral()  // Maven Central repository
          }
      
          dependencies {
            ...
      
            // Add the dependency for the Google services Gradle plugin
            classpath 'com.google.gms:google-services:4.3.13'
          }
      }
      
      allprojects {
        ...
      
        repositories {
          // Make sure that you have the following two repositories
          google()  // Google's Maven repository
          mavenCentral()  // Maven Central repository
        }
      }
      

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

      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）で、アプリで使用する Firebase プロダクトの依存関係を追加します。Firebase Android 部品構成表を使用して、ライブラリのバージョニングを管理することをおすすめします。

   アナリティクスが有効な場合

   Java

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:30.4.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'
   }
   

   Kotlin+KTX

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:30.4.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-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'
   }
   

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

   アナリティクスが無効な場合

   Java

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:30.4.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'
   }
   

   Kotlin+KTX

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:30.4.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-ktx'
     implementation 'com.google.firebase:firebase-firestore-ktx'
   }
   

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

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

   invoke-custom のサポートと脱糖の有効化に関するビルドエラーが発生した場合の修正方法は次のとおりです。

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

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

   • エラー メッセージに示されている compileOptions をアプリレベルの build.gradle ファイルに追加します。
   • Android プロジェクトの minSdkVersion を 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 ライブラリの詳細については、以下をご覧ください。

• リファレンス ドキュメント（Java | Kotlin+KTX）

• Firebase Android SDK GitHub リポジトリ

Firebase Android BoM を使用する場合、build.gradle で Firebase ライブラリの依存関係を宣言する際に、個々のライブラリ バージョンを指定しません。

次のステップ

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

• アナリティクスでユーザー行動を把握する。

• Authentication でユーザー認証フローを設定する。

• Cloud Firestore または Realtime Database にユーザー情報などのデータを保存する。

• Cloud Storage に写真や動画などのファイルを保存する。

• Cloud Functions を使用した安全な環境でバックエンド コードをトリガーする。

• Cloud Messaging を使用して通知を送信する。

• Crashlytics を使用してアプリがクラッシュする場所と理由を確認する。

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

• Firebase プロジェクトとプロジェクトに関するベスト プラクティスについては、Firebase プロジェクトについて理解するをご覧ください。

• なじみのないコンセプトや、Firebase および Android 開発に独自のコンセプトについて不明点がある場合は、Android と Firebase の詳細をご覧ください。

• Firebase アプリのサンプルを確認する。

• Firebase Android Codelab を使用して実際に体験する。

• Firebase in a Weekend コースで詳しく学習する。

• アプリをリリースする準備をする。

  • Google Cloud コンソールでプロジェクトの予算アラートを設定する。
  • Firebase コンソールの [使用量と請求額] ダッシュボードをモニタリングして、複数の Firebase サービスにまたがるプロジェクトの全体的な使用状況を確認する。
  • Firebase リリース チェックリストを確認する。

• Firebase や Android プロジェクトでお困りの場合は、Android のトラブルシューティングとよくある質問をご覧ください。