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

要件

Android Studio の最新バージョンをインストールするか、更新してください。
Android アプリを確認してください。
- API レベル 16（Jelly Bean）以降が対象です。
- Gradle 4.1 以降を使用します。
アプリを実行するためのデバイスまたはエミュレータを設定します。
- エミュレータでは 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 プロジェクトについて理解するをご覧ください。

Firebase プロジェクトを作成する

Firebase コンソールで [プロジェクトを追加] をクリックし、[プロジェクト名] を選択するか、新しいプロジェクト名を入力します。

既存の Google Cloud Platform（GCP）プロジェクトがある場合は、[プロジェクト名] プルダウンメニューからプロジェクトを選択できます。既存のプロジェクトがない場合は、新しいプロジェクト名を入力してください。
（省略可）プロジェクト ID を編集します。

Firebase プロジェクトには一意の ID が自動的に割り当てられます。Firebase がプロジェクト ID を使用する仕組みについては、Firebase プロジェクトについて理解するをご覧ください。

Firebase プロジェクトのリソースがプロビジョニングされた後にプロジェクト ID を変更することはできません。
特定の識別子を使用するには、この設定手順でプロジェクト ID を編集する必要があります。
Firebase コンソールで残りの設定手順を実施した後、[プロジェクトを作成]（既存の Google プロジェクトを使用する場合は [Firebase を追加]）をクリックします。

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

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

Firebase プロジェクトを作成したら、プロジェクトに Android アプリを追加できます。

Firebase プロジェクトにアプリを追加するベストプラクティス、考慮事項（複数のビルドバリエーションの扱い方など）の詳細については、Firebase プロジェクトについて理解するをご覧ください。

Firebase コンソールの [Project Overview] ページの中央にある Android アイコンをクリックして設定ワークフローを起動します。

すでに Firebase プロジェクトにアプリまたはゲームを追加している場合は、[アプリを追加] をクリックするとプラットフォームのオプションが表示されます。
アプリケーション ID を [Android パッケージ名] フィールドに入力します。

アプリが実際に使用している ID を入力してください。アプリを Firebase プロジェクトに登録した後で、この値を追加または変更することはできません。
- アプリケーション ID はパッケージ名と呼ばれることもあります。
- このアプリケーション ID はモジュール（アプリレベル）の Gradle ファイル（通常は app/build.gradle）内に記載されています（アプリケーション ID の例: com.yourcompany.yourproject）。
（省略可）設定ワークフローの指示に従って他のアプリ情報を入力します。

ニックネームは内部用の簡便な ID であり、Firebase コンソールでのみ表示されます。

注: SHA-1 情報は、（Google ログインまたは電話番号ログインを使用する場合）Firebase Authentication と Firebase Dynamic Links で必要になります。
[アプリの登録] をクリックします。

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

Firebase Android 構成ファイルをアプリに追加します。
1. [Download google-services.json] をクリックして、Firebase Android 構成ファイル（google-services.json）を取得します。
  - Firebase Android 構成ファイルはいつでも再ダウンロードできます。
  - 構成ファイルに (2) のような文字が追加されていないことを確認してください。
2. 構成ファイルをアプリのモジュール（アプリレベル）ディレクトリに移動します。
注: Firebase 構成ファイルには、プロジェクト用の機密ではない一意の識別子が含まれています。
構成ファイルの詳細については、Firebase プロジェクトについて理解するをご覧ください。

アプリで Firebase プロダクトを有効にするには、Gradle ファイルに google-services プラグインを追加します。

ルートレベル（プロジェクトレベル）の Gradle ファイル（build.gradle）に、Google サービスプラグインを含めるためのルールを追加します。Google の Maven リポジトリがあることも確認してください。

buildscript {

  repositories {
    // Check that you have the following line (if not, add it):
    google()  // Google's Maven repository
  }

  dependencies {
    // ...

    // Add the following line:
    classpath 'com.google.gms:google-services:4.2.0'  // Google Services plugin
  }
}

allprojects {
  // ...

  repositories {
    // Check that you have the following line (if not, add it):
    google()  // Google's Maven repository
    // ...
  }
}

モジュール（アプリレベル）の Gradle ファイル（通常は app/build.gradle）で、ファイルの末尾に以下の行を追加します。

apply plugin: 'com.android.application'

android {
  // ...
}

// Add the following line to the bottom of the file:
apply plugin: 'com.google.gms.google-services'  // Google Play services Gradle plugin

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

サポートされている Firebase プロダクトを Android アプリに追加できます。Firebase 向け Google アナリティクス機能を提供するコア Firebase SDK（com.google.firebase:firebase-core）から始めることをおすすめします。

モジュール（アプリレベル）の Gradle ファイル（通常は app/build.gradle）に、コア Firebase SDK の依存関係を追加します。

dependencies {
 // ...
 implementation 'com.google.firebase:firebase-core:17.0.0'

 // Getting a "Could not find" error? Make sure that you've added
 // Google's Maven repository to your root-level build.gradle file
}

（省略可）使用する他の Firebase ライブラリの依存関係を追加します。

一部の Android 向け Firebase SDK では、代わりに Kotlin 拡張ライブラリが提供されている場合があります。
アプリを同期して、すべての依存関係に必要なバージョンがあることを確認します。
アプリを実行して、Firebase の統合に成功したという認証を Firebase に送信します。

デバイスログには、初期化が完了したという Firebase の認証が表示されます。ネットワークへのアクセスが有効なエミュレータでアプリを実行した場合、Firebase コンソールによってアプリの接続完了が通知されます。

設定は以上です。状況に応じて次の手順に進んでください。

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

Firebase Assistant は、Firebase プロジェクトにアプリを登録し、Android プロジェクトに必要な Firebase ファイルとコードを追加します。これらはすべて Android Studio から行うことができます。

アプリを Firebase に接続するには、Firebase コンソールの設定ワークフローを使用することをおすすめします。

Android Studio で Android プロジェクトを開きます。
[Tools] > [Firebase] を選択して [Assistant] ウィンドウを開きます。
リストにある Firebase プロダクトのいずれか（例: アナリティクス）を展開し、チュートリアルリンク（例: アナリティクスイベント）をクリックします。
[Connect to Firebase] をクリックし、既存のまたは新規の Firebase プロジェクトにアプリを登録して、必要なファイルとコードが Android プロジェクトに自動的に追加されるようにします。
プラグインとライブラリのバージョンが最新であることを確認します。
- ルートレベル（プロジェクトレベル）の Gradle ファイル（build.gradle）で、Google サービスプラグインのバージョンが最新（com.google.gms:google-services:4.2.0）であることを確認します。
- モジュール（アプリレベル）の Gradle ファイル（通常は app/build.gradle）で、Firebase Android ライブラリのバージョンが最新であることを確認します。
注: Android Studio v3.2 以前を使用している場合は、それぞれの依存関係行に、バージョン番号が 1 つだけ指定されていることを確認してください。
アプリを同期して、すべての依存関係に必要なバージョンがあることを確認します。
Firebase コンソールの [プロジェクトの設定] で、アナリティクスデータの共有設定を構成します。
Firebase Predictions や Firebase A/B Testing などの Firebase プロダクトを使用するには、他の Firebase プロダクトとアナリティクスデータを共有できるようにする必要があります。
アプリを実行して、Firebase の統合に成功したという認証を Firebase に送信します。

デバイスログには、初期化が完了したという Firebase の認証が表示されます。ネットワークへのアクセスが有効なエミュレータでアプリを実行した場合、Firebase コンソールによってアプリの接続完了が通知されます。

使用可能なライブラリ

さまざまな Firebase プロダクトで使用できる Android ライブラリは次のとおりです。

一部の Android 向け Firebase SDK では、代わりに Kotlin 拡張ライブラリが提供されている場合があります。

サービスまたはプロダクト	Gradle の依存関係行
Google Play 開発者サービスプラグイン	com.google.gms:google-services:4.2.0
AdMob	com.google.firebase:firebase-ads:18.0.0
アナリティクス	com.google.firebase:firebase-core:17.0.0
App Indexing	com.google.firebase:firebase-appindexing:19.0.0
Authentication	com.google.firebase:firebase-auth:18.0.0
Cloud Firestore	com.google.firebase:firebase-firestore:20.0.0
Cloud Functions for Firebase Client SDK	com.google.firebase:firebase-functions:18.0.0
Cloud Messaging	com.google.firebase:firebase-messaging:19.0.0
Cloud Storage	com.google.firebase:firebase-storage:18.0.0
Crashlytics	com.crashlytics.sdk.android:crashlytics:2.10.1
Dynamic Links	com.google.firebase:firebase-dynamic-links:18.0.0
アプリ内メッセージング	com.google.firebase:firebase-inappmessaging:18.0.0
アプリ内メッセージング表示	com.google.firebase:firebase-inappmessaging-display:18.0.0
ML Kit: Vision API	com.google.firebase:firebase-ml-vision:21.0.0
ML Kit: 画像ラベル付けモデル	com.google.firebase:firebase-ml-vision-image-label-model:18.0.0
ML Kit: 顔検出モデル	com.google.firebase:firebase-ml-vision-face-model:18.0.0
ML Kit: オブジェクトの検出とトラッキングモデル	com.google.firebase:firebase-ml-vision-object-detection-model:17.0.0
ML Kit: Natural Language API	com.google.firebase:firebase-ml-natural-language:20.0.0
ML Kit: 言語識別モデル	com.google.firebase:firebase-ml-natural-language-language-id-model:20.0.0
ML Kit: 翻訳モデル	com.google.firebase:firebase-ml-natural-language-translate-model:20.0.0
ML Kit: スマートリプライモデル	com.google.firebase:firebase-ml-natural-language-smart-reply-model:20.0.0
ML Kit: カスタムモデル API	com.google.firebase:firebase-ml-model-interpreter:20.0.0
ML Kit: AutoML Vision Edge API	com.google.firebase:firebase-ml-vision-automl:17.0.0
Performance Monitoring	com.google.firebase:firebase-perf:18.0.0
Realtime Database	com.google.firebase:firebase-database:18.0.0
Remote Config	com.google.firebase:firebase-config:18.0.0

Firebase BoM（部品表）によってライブラリのバージョニングを管理する（試験運用版）

Firebase BoM（部品表）をインポートすることで、ライブラリのバージョン管理が容易になります。

Firebase BoM を使用してアプリに Firebase SDK を追加する

Firebase の BoM Gradle 機能を使用することで、Firebase プラットフォーム全体のバージョンを設定できます。Firebase BoM の各バージョンには、Firebase ライブラリの互換バージョンが含まれています。特定のバージョンの BoM にマッピングされているライブラリのバージョンについては、リリースノートをご覧ください。

最新バージョンの BoM に更新すると、すべての Firebase Android ライブラリが、その BoM のリリース時に提供されている最新バージョンに更新されます。

Firebase BoM を使用してアプリに Firebase SDK を追加するには、次のようにします。

Gradle 5.0 以降では、BoM が自動的にサポートされます。モジュールの Gradle ファイルで依存関係を設定します（通常は app/build.gradle）。

dependencies {
  // Import the platform
  implementation platform('com.google.firebase:firebase-bom:20.0.0')

  // When using a BoM, dependencies don't require a specified version
  // If you do specify a version, it overrides the library version specified in the BoM
  implementation 'com.google.firebase:firebase-core'
  implementation 'com.google.firebase:firebase-auth'
  implementation 'com.google.firebase:firebase-firestore'
}

以前のバージョンの Gradle の場合は、BoM 機能を有効にする必要があります。
1. settings.gradle ファイルに enableFeaturePreview('IMPROVED_POM_SUPPORT') を追加します。
2. 通常のライブラリのように（platform 修飾子を使用しないで）BoM をインポートします。

依存関係に firebase-bom を追加すると、バージョンを指定しないで Firebase ライブラリを宣言できるようになります。Firebase BoM のバージョンを更新するだけで、Firebase ライブラリのバージョンが更新されます。

Firebase BoM に関する問題を報告するか、フィードバックを提供する場合は、GitHub の Firebase Android SDK リポジトリにアクセスしてください。

次のステップ

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

Firebase プロジェクトとプロジェクトに関するベストプラクティスについては、Firebase プロジェクトについて理解するをご覧ください。
Firebase アプリのサンプルを確認する。
Firebase Android Codelab を使用して実際に体験する。
Firebase in a Weekend コースで詳しく学習する。
アプリを起動する準備する。
- 請求アラートを設定する。
- Firebase リリースチェックリストを確認する。

Firebase 機能をアプリに追加します。

アナリティクスでユーザー行動を把握する。
Authentication でユーザー認証フローを設定する。
Cloud Firestore または Realtime Database にユーザー情報などのデータを保存する。
Cloud Storage に写真や動画などのファイルを保存する。
Cloud Functions を使用した安全な環境でバックエンドコードをトリガーする。
Cloud Messaging を使用して通知を送信する。
Crashlytics を使用してアプリがクラッシュする場所と理由を確認する。