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 プロジェクトについて理解するをご覧ください。

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

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

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

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

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

  2. アプリケーション ID を [Android パッケージ名] に入力します。

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

    • このアプリケーション ID はモジュール(アプリレベル)の Gradle ファイル(通常は app/build.gradle)内に記載されています(アプリケーション ID の例: com.yourcompany.yourproject)。

  3. (省略可)設定ワークフローの指示に従って他のアプリ情報を入力します。

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

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

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

  1. Firebase Android 構成ファイルをアプリに追加します。

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

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

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

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

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

      buildscript {
        // ...
        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
          // ...
        }
      }
      
    2. モジュール(アプリレベル)の 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)から始めることをおすすめします。

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

    dependencies {
     // ...
     implementation 'com.google.firebase:firebase-core:16.0.8'
    
     // Getting a "Could not find" error? Make sure that you've added
     // Google's Maven repository to your root-level build.gradle file
    }
    
  2. (省略可)使用するその他の Firebase プロダクトの依存関係を追加します。

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

  4. アプリを実行して、Firebase の統合に成功したという認証を Firebase に送信します。

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

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

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

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

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

  1. Android Studio で Android プロジェクトを開きます。

  2. [Tools] > [Firebase] を選択して [Assistant] ウィンドウを開きます。

  3. リストにある Firebase プロダクトのいずれか(例: アナリティクス)を展開し、チュートリアル リンク(例: アナリティクス イベント)をクリックします。

  4. [Connect to Firebase] をクリックし、既存のまたは新規の Firebase プロジェクトにアプリを登録して、必要なファイルとコードが Android プロジェクトに自動的に追加されるようにします。

  5. プラグインとライブラリのバージョンが最新であることを確認します。

    • ルートレベル(プロジェクト レベル)の Gradle ファイル(build.gradle)で、Google サービス プラグインのバージョンが最新(com.google.gms:google-services:4.2.0)であることを確認します。

    • モジュール(アプリレベル)の Gradle ファイル(通常は app/build.gradle)で、Firebase Android ライブラリのバージョンが最新であることを確認します。

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

  7. Firebase コンソールの [プロジェクトの設定] で、アナリティクス データの共有設定を構成します。
    Firebase Predictions や Firebase A/B Testing などの Firebase プロダクトを使用するには、他の Firebase プロダクトとアナリティクス データを共有できるようにする必要があります。

  8. アプリを実行して、Firebase の統合に成功したという認証を Firebase に送信します。

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

使用可能なライブラリ

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

サービスまたはプロダクト Gradle の依存関係行
Google Play 開発者サービス プラグイン com.google.gms:google-services:4.2.0
AdMob com.google.firebase:firebase-ads:17.2.0
アナリティクス com.google.firebase:firebase-core:16.0.8
App Indexing com.google.firebase:firebase-appindexing:17.1.0
Authentication com.google.firebase:firebase-auth:16.2.0
Cloud Firestore com.google.firebase:firebase-firestore:18.1.0
Cloud Functions for Firebase Client SDK com.google.firebase:firebase-functions:16.3.0
Cloud Messaging com.google.firebase:firebase-messaging:17.4.0
Cloud Storage com.google.firebase:firebase-storage:16.1.0
Crashlytics com.crashlytics.sdk.android:crashlytics:2.9.9
アプリ内メッセージング com.google.firebase:firebase-inappmessaging:17.1.0
アプリ内メッセージング表示 com.google.firebase:firebase-inappmessaging-display:17.1.0
ML Kit: カスタムモデル com.google.firebase:firebase-ml-model-interpreter:17.0.3
ML Kit: 画像のラベル付け com.google.firebase:firebase-ml-vision-image-label-model:17.0.2
ML Kit: Natural Language com.google.firebase:firebase-ml-natural-language:18.1.1
ML Kit: Natural Language - 言語 ID モデル com.google.firebase:firebase-ml-natural-language-language-id-model:18.0.2
ML Kit: Vision com.google.firebase:firebase-ml-vision:19.0.2
Performance Monitoring com.google.firebase:firebase-perf:16.2.4
Realtime Database com.google.firebase:firebase-database:16.1.0
Remote Config com.google.firebase:firebase-config:16.4.0

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

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

次のステップ

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

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