Android アプリでメッセージを受信する

Firebase Notifications は、受信側アプリがフォアグラウンド状態であるかバックグラウンド状態であるかによって、動作が異なります。フォアグラウンド アプリで通知メッセージまたはデータ メッセージを受信する場合は、onMessageReceived コールバックを処理するコードを記述する必要があります。通知メッセージとデータ メッセージの違いの説明については、メッセージのタイプをご覧ください。

メッセージの処理

メッセージを受信するには、FirebaseMessagingService を拡張したサービスを使用します。このサービスは onMessageReceived コールバックと onDeletedMessages コールバックをオーバーライドする必要があります。メッセージは受信から 20 秒以内に処理されるようにします（Android Marshmallow では 10 秒）。時間枠は、onMessageReceived を呼び出す前に発生した OS の遅延に応じて短くなる場合があります。この時間が経過すると、Android O のバックグラウンド実行制限などの OS の各種動作によって、作業完了が妨げられる可能性があります。詳細については、メッセージの優先度の概要をご覧ください。

onMessageReceived は次の例外を除いて、ほとんどのメッセージ タイプに提供されます。

• アプリがバックグラウンドで動作しているときに配信された通知メッセージ。この場合、通知はデバイスのシステムトレイに配信されます。ユーザーが通知をタップすると、デフォルトでアプリ ランチャーが開きます。

• バックグラウンドで受信されたときに通知とデータ ペイロードの両方を持つメッセージ。この場合、通知はデバイスのシステムトレイに配信され、データ ペイロードはランチャー アクティビティのインテントの追加部分に配信されます。

要約:

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

FirebaseMessagingService を使用するには、アプリ マニフェストに次の設定を追加する必要があります。

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

通知のデザインをカスタマイズするためのデフォルト値を設定することもおすすめします。通知ペイロード内にアイコンやカラーの値が設定されていない場合に適用される、カスタム デフォルト アイコンとカスタム デフォルト カラーを指定できます。

カスタム デフォルト アイコンとカスタムカラーを設定するには、次の行を application タグに追加します。

<!-- 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 では、以下に対してカスタム デフォルト アイコンが表示されます。

• Notifications Composer から送信されたすべての通知メッセージ。
• 通知ペイロード内にアイコンが明示的に設定されていない通知メッセージ。

Android では、以下に対してカスタム デフォルト カラーが使用されます。

• Notifications Composer から送信されたすべての通知メッセージ。
• 通知ペイロード内にカラーが明示的に設定されていない通知メッセージ。

カスタム デフォルト アイコンが設定されず、通知ペイロード内にもアイコンが設定されていない場合は、Android では白色でレンダリングされたアプリケーション アイコンが表示されます。

onMessageReceived のオーバーライド

FirebaseMessagingService.onMessageReceived メソッドをオーバーライドすると、受信した RemoteMessage オブジェクトに基づいてアクションを実行し、メッセージ データを取得できます。

override fun onMessageReceived(remoteMessage: RemoteMessage) {
    // TODO(developer): Handle FCM messages here.
    // Not getting messages here? See why this may be: https://goo.gl/39bRNJ
    Log.d(TAG, "From: ${remoteMessage.from}")

    // Check if message contains a data payload.
    if (remoteMessage.data.isNotEmpty()) {
        Log.d(TAG, "Message data payload: ${remoteMessage.data}")

        // Check if data needs to be processed by long running job
        if (needsToBeScheduled()) {
            // For long-running tasks (10 seconds or more) use WorkManager.
            scheduleJob()
        } else {
            // Handle message within 10 seconds
            handleNow()
        }
    }

    // Check if message contains a notification payload.
    remoteMessage.notification?.let {
        Log.d(TAG, "Message Notification Body: ${it.body}")
    }

    // Also if you intend on generating your own notifications as a result of a received FCM
    // message, here is where that should be initiated. See sendNotification method below.
}
MyFirebaseMessagingService.kt

@Override
public void onMessageReceived(RemoteMessage remoteMessage) {
    // TODO(developer): Handle FCM messages here.
    // Not getting messages here? See why this may be: https://goo.gl/39bRNJ
    Log.d(TAG, "From: " + remoteMessage.getFrom());

    // Check if message contains a data payload.
    if (remoteMessage.getData().size() > 0) {
        Log.d(TAG, "Message data payload: " + remoteMessage.getData());

        if (/* Check if data needs to be processed by long running job */ true) {
            // For long-running tasks (10 seconds or more) use WorkManager.
            scheduleJob();
        } else {
            // Handle message within 10 seconds
            handleNow();
        }

    }

    // Check if message contains a notification payload.
    if (remoteMessage.getNotification() != null) {
        Log.d(TAG, "Message Notification Body: " + remoteMessage.getNotification().getBody());
    }

    // Also if you intend on generating your own notifications as a result of a received FCM
    // message, here is where that should be initiated. See sendNotification method below.
}
MyFirebaseMessagingService.java

onDeletedMessages のオーバーライド

バックグラウンド アプリの通知メッセージの処理

アプリがバックグラウンドで動作しているとき、Android ではシステムトレイに通知メッセージが送られます。ユーザーが通知をタップすると、デフォルトでアプリ ランチャーが開きます。

通知とデータ ペイロードの両方を含むメッセージ（および Notifications コンソールから送信されたすべてのメッセージ）がここに含まれます。この場合、通知はデバイスのシステムトレイに配信され、データ ペイロードはランチャー アクティビティのインテントの追加部分に配信されます。

アプリへのメッセージ配信については、FCM レポート ダッシュボードをご覧ください。このダッシュボードには、Android アプリの「インプレッション」（ユーザーが表示した通知）のデータとともに、Apple と Android のデバイスで送信および開封されたメッセージの数が記録されています。

ダイレクト ブート モードで FCM メッセージを受信する

デバイスのロックが解除される前にアプリに FCM メッセージを送信したい場合は、デバイスがダイレクト ブート モードのときにメッセージを受信するように Android アプリを設定できます。たとえば、ロックされたデバイスでも、アラーム通知がアプリのユーザーに届くようにしたい場合があるかもしれません。

このユースケースを構築する場合は、ダイレクト ブート モードに関する一般的なベスト プラクティスと制限事項を遵守してください。ダイレクト ブートに対応したメッセージの可視性を考慮することが特に重要です。デバイスにアクセスできるユーザーであれば、ユーザーの認証情報を入力しなくてもこれらのメッセージを見ることができるためです。

前提条件

• デバイスをダイレクト ブート モードに設定する必要があります。
• デバイスに Google Play 開発者サービスの新しいバージョン（19.0.54 以降）がインストールされている必要があります。
• アプリは FCM SDK（com.google.firebase:firebase-messaging）を使用して FCM メッセージを受信する必要があります。

アプリでダイレクト ブート モードのメッセージ処理を有効にする

1. アプリレベルの Gradle ファイルで、FCM ダイレクト ブート サポート ライブラリの依存関係を追加します。

   implementation 'com.google.firebase:firebase-messaging-directboot:20.2.0'
   

2. アプリ マニフェストで android:directBootAware="true" 属性を追加して、アプリの FirebaseMessagingService をダイレクト ブート対応にします。

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

この FirebaseMessagingService をダイレクト ブート モードで実行できるようにすることが重要です。次の要件を確認してください。

• ダイレクト ブート モードでの実行中、サービスは認証情報で保護されたストレージにアクセスできません。
• ダイレクト ブート モードでの実行中、サービスはダイレクト ブート対応として指定されていない Activities、BroadcastReceivers、Services などのコンポーネントを使用できません。
• ダイレクト ブート モードでの実行中、サービスで使用するライブラリは、認証情報で保護されたストレージにアクセスしたり、ダイレクト ブートに対応しないコンポーネントを呼び出したりすることはできません。つまり、アプリが使用し、サービスから呼び出されるライブラリは、ダイレクト ブート対応である必要があります。ダイレクト ブート対応でないライブラリについては、アプリは現在実行中のモードを確認し、ダイレクト ブート モードで実行中の場合はそれらのライブラリを呼び出さないようにする必要があります。たとえば、Firebase SDK はダイレクト ブートで動作しますが（アプリに含めてもダイレクト ブート モードでアプリのクラッシュを発生させることはありません）、多くの Firebase API はダイレクト ブート モードでの呼び出しに対応していません。
• アプリでカスタムの Application を使用している場合は、Application もダイレクト ブート対応である必要があります（ダイレクト ブート モードでは認証情報で保護されたストレージにアクセスできません）。

ダイレクト ブート モードのデバイスにメッセージを送信する場合のガイダンスについては、ダイレクト ブート対応のメッセージを送信するをご覧ください。