Android で Firebase Cloud Messaging クライアントアプリを設定する

Firebase Cloud Messaging Android クライアントアプリを作成するには、FirebaseMessaging API と Android Studio 1.4 以降を Gradle とともに使用します。このページの説明では、Firebase を Android プロジェクトに追加する手順がすでに完了済みであることを前提としています。

FCM クライアントには Android 4.1 以降を実行しているデバイスが必要です。またそのデバイスには、Google Play ストアアプリがインストールされているか、Google API を使用して Android 4.1 が動作しているエミュレータが搭載されている必要があります。ただし、開発した Android アプリは Google Play ストア経由以外の手段でもデプロイできます。

SDK を設定する

このセクションで説明しているタスクは、他の Firebase 機能をアプリですでに有効にしている場合は完了している可能性があります。

準備

Android Studio の最新バージョンをインストールするか、更新してください。
プロジェクトが次の要件を満たしていることを確認します。
- API レベル 16（Jelly Bean）以降が対象です。
- Gradle 4.1 以降を使用します。
- Jetpack（AndroidX）を使用します。また、次のバージョン要件を満たしている必要があります。
  - com.android.tools.build:gradle v3.2.1 以降
  - compileSdkVersion 28 以降
物理デバイスを設定するか、エミュレータを使用してアプリを実行します。
エミュレータでは Google Play のエミュレータイメージを使用する必要があります。
Google アカウントを使用して Firebase にログインします。

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

Firebase プロジェクトを作成

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

Firebase プロジェクトを作成

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

既存の Google Cloud Platform（GCP）プロジェクトがある場合は、プルダウンメニューからプロジェクトを選択して、そのプロジェクトに Firebase リソースを追加できます。
（省略可）新しいプロジェクトを作成する場合は、プロジェクト ID を編集できます。

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

Firebase プロジェクトのリソースがプロビジョニングされた後にプロジェクト ID を変更することはできません。
特定の識別子を使用するには、この設定段階でプロジェクト ID を編集する必要があります。
[続行] をクリックします。

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

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

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

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

Firebase を使用してアプリを登録する

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

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

Firebase コンソールに移動します。
プロジェクトの概要ページの中央で、Android アイコン（）をクリックして設定ワークフローを起動します。

すでに Firebase プロジェクトにアプリを追加している場合は、[アプリを追加] をクリックするとプラットフォームのオプションが表示されます。
[Android パッケージ名] フィールドにアプリのパッケージ名を入力します。
パッケージ名とその場所
- パッケージ名は、デバイスと Google Play ストアでアプリを一意に識別するものです。
- パッケージ名はアプリケーション ID と呼ばれることもあります。
- モジュール（アプリレベル）の Gradle ファイルでアプリのパッケージ名を探します。通常は app/build.gradle です（例: com.yourcompany.yourproject）。
- パッケージ名の値は大文字と小文字が区別されます。Firebase プロジェクトに登録された後、この Firebase Android アプリのパッケージ名は変更できないことに注意してください。
アプリが実際に使用しているパッケージ名を入力してください。パッケージ名の値は大文字と小文字が区別されます。Firebase プロジェクトに登録された後、この Firebase Android アプリのパッケージ名は変更できません。
（省略可）その他のアプリ情報（アプリのニックネームとデバッグ用の署名証明書 SHA-1）を入力します。
Firebase 内でアプリのニックネームとデバッグ用の署名証明書 SHA-1 はどのように使用されますか？
- アプリのニックネーム: 内部用の簡易的な ID であり、Firebase コンソールでのみ表示されます。
- デバッグ用の署名証明書 SHA-1: SHA-1 ハッシュは Firebase Authentication（Google ログインまたは電話番号ログインを使用する場合）と Firebase Dynamic Links で必要です。
[アプリの登録] をクリックします。

Firebase 構成ファイルを追加する

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

アプリで 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.3.3'  // 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）で、Google サービスの Gradle プラグインを適用します。

apply plugin: 'com.android.application'
// Add the following line:
apply plugin: 'com.google.gms.google-services'  // Google Services plugin

android {
  // ...
}

アプリに Firebase SDK を追加する

モジュール（アプリレベル）の Gradle ファイル（通常は app/build.gradle）に、アプリで使用する Firebase プロダクトの依存関係を追加します。

サポートされている Firebase プロダクトを Android アプリに追加できます。

Firebase Cloud Messaging のエクスペリエンスを最適化するために、プロジェクトで Google アナリティクスを有効にすることをおすすめします。また、Google アナリティクスの設定の一環として、Google アナリティクス用の Firebase SDK をアプリに追加する必要もあります。
アナリティクスが有効な場合
```
dependencies {
  // ...

  // Add the dependencies for the Firebase Cloud Messaging and Analytics libraries
  implementation 'com.google.firebase:firebase-messaging:20.2.4'
  implementation 'com.google.firebase:firebase-analytics:17.5.0'
}

// Getting a "Could not find" error? Make sure that you've added
// Google's Maven repository to your project-level build.gradle file
```
アナリティクスが無効な場合
```
dependencies {
  // ...

  // Add the dependency for the Firebase Cloud Messaging library
  implementation 'com.google.firebase:firebase-messaging:20.2.4'
}

// Getting a "Could not find" error? Make sure that you've added
// Google's Maven repository to your project-level build.gradle file
```
アプリを同期して、すべての依存関係に必要なバージョンがあることを確認します。

アプリのマニフェストを編集する

アプリのマニフェストに次の追加を行います。

FirebaseMessagingService を継承したサービス。これは、バックグラウンド時にアプリで通知を受け取る処理よりも高度なメッセージ処理を行う場合に必要になります。フォアグラウンド時のアプリで通知を受け取る、データペイロードを受信する、アップストリームメッセージを送信するなどの場合は、このサービスを継承する必要があります。

<service
    android:name=".java.MyFirebaseMessagingService"
    android:exported="false">
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT" />
    </intent-filter>
</service>AndroidManifest.xml

（オプション）通知のデフォルトのアイコンと色を設定する、アプリケーションコンポーネント内のメタデータ要素。着信メッセージでアイコンや色が明示的に設定されていない場合、Android ではこれらの値を使用します。

<!-- Set custom default icon. This is used when no icon is set for incoming notification messages.
     See README(https://goo.gl/l4GJaQ) for more. -->
<meta-data
    android:name="com.google.firebase.messaging.default_notification_icon"
    android:resource="@drawable/ic_stat_ic_notification" />
<!-- Set color used with incoming notification messages. This is used when no color is set for the incoming
     notification message. See README(https://goo.gl/6BKBk7) for more. -->
<meta-data
    android:name="com.google.firebase.messaging.default_notification_color"
    android:resource="@color/colorAccent" />AndroidManifest.xml

（オプション）Android 8.0（API レベル 26）以降では、通知チャネルがサポートされ、推奨されています。FCM には、基本設定付きのデフォルト通知チャネルがあります。独自のデフォルトチャネルを作成して使用する場合は、default_notification_channel_id を通知チャネルオブジェクトの ID に設定します（下記を参照）。受信メッセージで通知チャネルが明示的に設定されていない場合、FCM では常にこの値が使用されます。詳細については、通知チャネルの管理をご覧ください。

<meta-data
    android:name="com.google.firebase.messaging.default_notification_channel_id"
    android:value="@string/default_notification_channel_id" />AndroidManifest.xml

デバイス登録トークンにアクセスする

アプリを初めて起動すると、クライアントアプリのインスタンスの登録トークンが FCM SDK によって生成されます。単一のデバイスを対象にする場合、またはデバイスグループを作成する場合は、FirebaseMessagingService を拡張して onNewToken をオーバーライドすることで、このトークンにアクセスする必要があります。

このセクションでは、トークンを取得する方法とトークンに対する変更をモニタリングする方法について説明します。トークンは最初の起動後にローテーションされている可能性があるため、更新された最新の登録トークンを取得することを強くおすすめします。

登録トークンは次のような場合に変更されることがあります。

アプリによってインスタンス ID が削除される場合
アプリが新しいデバイスで復元される場合
ユーザーがアプリをアンインストール / 再インストールする場合
ユーザーがアプリのデータを消去する場合

現在の登録トークンの取得

現在のトークンを取得する必要がある場合は、FirebaseInstanceId.getInstance().getInstanceId() を呼び出します。

Java

FirebaseInstanceId.getInstance().getInstanceId()
        .addOnCompleteListener(new OnCompleteListener<InstanceIdResult>() {
            @Override
            public void onComplete(@NonNull Task<InstanceIdResult> task) {
                if (!task.isSuccessful()) {
                    Log.w(TAG, "getInstanceId failed", task.getException());
                    return;
                }

                // Get new Instance ID token
                String token = task.getResult().getToken();

                // Log and toast
                String msg = getString(R.string.msg_token_fmt, token);
                Log.d(TAG, msg);
                Toast.makeText(MainActivity.this, msg, Toast.LENGTH_SHORT).show();
            }
        });MainActivity.java

Kotlin+KTX

FirebaseInstanceId.getInstance().instanceId
        .addOnCompleteListener(OnCompleteListener { task ->
            if (!task.isSuccessful) {
                Log.w(TAG, "getInstanceId failed", task.exception)
                return@OnCompleteListener
            }

            // Get new Instance ID token
            val token = task.result?.token

            // Log and toast
            val msg = getString(R.string.msg_token_fmt, token)
            Log.d(TAG, msg)
            Toast.makeText(baseContext, msg, Toast.LENGTH_SHORT).show()
        })MainActivity.kt

トークンの生成のモニタリング

onNewToken コールバックは、新しいトークンが生成されるたびに呼び出されます。

Java

/**
 * Called if InstanceID token is updated. This may occur if the security of
 * the previous token had been compromised. Note that this is called when the InstanceID token
 * is initially generated so this is where you would retrieve the token.
 */
@Override
public void onNewToken(String token) {
    Log.d(TAG, "Refreshed token: " + token);

    // If you want to send messages to this application instance or
    // manage this apps subscriptions on the server side, send the
    // Instance ID token to your app server.
    sendRegistrationToServer(token);
}MyFirebaseMessagingService.java

Kotlin+KTX

/**
 * Called if InstanceID token is updated. This may occur if the security of
 * the previous token had been compromised. Note that this is called when the InstanceID token
 * is initially generated so this is where you would retrieve the token.
 */
override fun onNewToken(token: String) {
    Log.d(TAG, "Refreshed token: $token")

    // If you want to send messages to this application instance or
    // manage this apps subscriptions on the server side, send the
    // Instance ID token to your app server.
    sendRegistrationToServer(token)
}MyFirebaseMessagingService.kt

トークンを取得したら、それをアプリサーバーに送信して、適切な方法で保管できます。API の詳細については、インスタンス ID API リファレンスをご覧ください。

Google Play 開発者サービスのチェック

Play 開発者サービスの SDK に依存するアプリについては、Google Play 開発者サービス機能にアクセスする前に、互換性のある Google Play 開発者サービスの APK がデバイスにインストールされているかどうかをアプリが必ずチェックする必要があります。このチェックは、メインアクティビティの onCreate() メソッドと onResume() メソッドの 2 か所で行うことをおすすめします。onCreate() では、チェックにパスしないとアプリを使用できないようにします。onResume() では、ユーザーが [戻る] ボタンなどの他の手段を使って実行中のアプリに戻った場合にもチェックされるようにします。

互換性のあるバージョンの Google Play 開発者サービスがデバイスにインストールされていない場合は、アプリで GoogleApiAvailability.makeGooglePlayServicesAvailable() を呼び出すと、ユーザーが Google Play ストアから Google Play 開発者サービスをダウンロードできます。

自動初期化を禁止する

FCM は、Firebase が生成するインスタンス ID を使用して登録トークンを生成します。また、アナリティクスは、この ID を使用してデータを収集します。インスタンス ID が生成されると、ライブラリではその ID と構成データが Firebase にアップロードされます。インスタンス ID の自動生成を禁止するには、次のようにメタデータ値を AndroidManifest.xml に追加して、FCM とアナリティクスで自動初期化を無効にします（両方で無効にする必要があります）。

<meta-data
    android:name="firebase_messaging_auto_init_enabled"
    android:value="false" />
<meta-data
    android:name="firebase_analytics_collection_enabled"
    android:value="false" />AndroidManifest.xml

FCM をもう一度有効にするには、ランタイムコールを行います。

Java

FirebaseMessaging.getInstance().setAutoInitEnabled(true);MainActivity.java

Kotlin+KTX

FirebaseMessaging.getInstance().isAutoInitEnabled = trueMainActivity.kt

この値をいったん設定すると、アプリを再起動しても維持されます。

次のステップ

クライアントアプリの設定が完了すると、Notifications Composer でダウンストリームメッセージを送信できるようになります。この機能は、ダウンロードして実行可能なクイックスタートサンプルで確認できます。

その他のより高度な動作をアプリに追加するには、インテントフィルタを宣言して、受信メッセージに応答するアクティビティを実装します。詳細については、アプリサーバーからメッセージを送信するためのガイドをご覧ください。

これらの機能を利用するには、サーバーの実装とサーバープロトコル（HTTP または XMPP）、あるいは Admin SDK の実装が必要になることに注意してください。

Android で Firebase Cloud Messaging クライアント アプリを設定する

SDK を設定する

準備

Firebase プロジェクトを作成

Firebase を使用してアプリを登録する

Firebase 構成ファイルを追加する

アプリに Firebase SDK を追加する

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

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

アプリのマニフェストを編集する

デバイス登録トークンにアクセスする

現在の登録トークンの取得

Java

Kotlin+KTX

トークンの生成のモニタリング

Java

Kotlin+KTX

Google Play 開発者サービスのチェック

自動初期化を禁止する

Java

Kotlin+KTX

次のステップ

Android で Firebase Cloud Messaging クライアントアプリを設定する