通知をユーザー セグメントに送信する

ユーザー セグメントを使用すると、特定のユーザーグループに通知を送信できます。定義済みのユーザー セグメントを対象にすることも、Firebase Analytics で作成したカスタムのユーザーリストを対象にすることもできます。

SDK を設定する

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

事前準備

  • Android 2.3(Gingerbread)以降、および Google Play 開発者サービス 10.0.1 以降が搭載された端末
  • Android SDK マネージャーで利用可能な Google レポジトリの Google Play 開発者サービス SDK
  • Android Studio の最新バージョン(バージョン 1.5 以降)

Android Studio プロジェクトをまだ用意していない場合、Firebase 機能を試すだけであれば、クイックスタート サンプルをダウンロードしてご利用いただけます。クイックスタートを使用する場合は、プロジェクトのモジュール フォルダ(通常は app/)内の build.gradle ファイルからアプリケーション ID を取得してください。このパッケージ名が次のステップで必要になるからです。

アプリに Firebase を追加する

アプリに Firebase を追加するには、Firebase プロジェクトと、アプリ用の Firebase 設定ファイルが必要です。

  1. Firebase プロジェクトをまだ用意していない場合は、Firebase console で Firebase プロジェクトを作成します。モバイルアプリと関連付けられた既存の Google プロジェクトがある場合は、[Google プロジェクトをインポート] をクリックします。それ以外の場合は、[新規プロジェクトを作成] をクリックします。
  2. [Android アプリに Firebase を追加] をクリックし、設定手順に沿って操作します。既存の Google プロジェクトをインポートする場合、このステップは自動的に実行されることがあります。その場合は、設定ファイルをダウンロードするだけでかまいません。
  3. プロンプトが表示されたら、アプリのパッケージ名を入力します。必ずアプリで使用しているパッケージ名を入力してください。パッケージ名を設定できるのは、アプリを Firebase プロジェクトに追加するときだけです。
  4. google-services.json ファイルをダウンロードします。このファイルはいつでももう一度ダウンロードできます。
  5. このファイルをプロジェクトのモジュール フォルダ(通常は app/)にコピーしていない場合は、コピーします。

SDK を追加する

Firebase ライブラリをプロジェクトに統合する場合は、Android Studio プロジェクトを準備するためのいくつかの基本タスクを実行する必要があります。ただし、アプリに Firebase を追加するときに、既にこの手順を完了している可能性があります。

まず、google-services プラグインを含めるように、ルートレベルの build.gradle ファイルにルールを追加します。

buildscript {
    // ...
    dependencies {
        // ...
        classpath 'com.google.gms:google-services:3.0.0'
    }
}

次に、モジュールの Gradle ファイル(通常は app/build.gradle)の末尾に apply plugin 行を追加して、Gradle プラグインを有効にします。

apply plugin: 'com.android.application'

android {
  // ...
}

dependencies {
  // ...
  compile 'com.google.firebase:firebase-core:10.0.1'
  compile 'com.google.firebase:firebase-messaging:10.0.1'
  // Getting a "Could not find" error? Make sure you have
  // the latest Google Repository in the Android SDK manager
}

// ADD THIS AT THE BOTTOM
apply plugin: 'com.google.gms.google-services'

また、使用する Firebase SDK の依存関係も追加する必要があります。はじめに、Firebase Analytics 機能を提供する com.google.firebase:firebase-core から開始することをおすすめします。使用可能なライブラリの一覧をご覧ください。

Notifications コンソールからメッセージを送信する

  1. ターゲット端末でアプリをインストールして実行します。

  2. Firebase console の [通知] タブを開き、[新しいメッセージ] を選択します。

  3. メッセージのテキストを入力します。

  4. メッセージのターゲットを選択します。ダイアログには、[アプリ/アプリのバージョン]、[端末の言語]、または [ユーザーリスト内のユーザー] のどれを選択したのかに基づいてターゲットを絞り込む詳細オプションが表示されます。

[メッセージを送信] をクリックすると、アプリをバックグラウンドで実行しているターゲット クライアント端末のシステム通知トレイに通知が届きます。ユーザーが通知をタップすると、アプリが起動されます。

コンソールのフィールドとメッセージ ペイロード

Notifications コンソールから通知メッセージを送信すると、Google は Composer で入力されたフィールドを次の 2 つの方法で使用します。

  1. [ユーザー セグメント] や [有効期限] などの欄によってメッセージのターゲットと配信オプションを決定します。
  2. [メッセージ文] や [カスタムデータ] などのフィールドは、Key-Value ペアで構成されたペイロードでクライアントに送信されます。

後者のキーの一部は FCM サーバー API を通じても利用できます。 たとえば、[カスタムデータ] に入力された Key-Value ペアは通知のデータ ペイロードとして処理されます。他のフィールドは FCM 通知ペイロードのキーに直接マッピングされます。

Notifications コンソールの一部のフィールドは FCM サーバーの API では使用できないことに注意してください。たとえば、複数の方法を使用してアプリ、アプリ バージョン、または言語に基づいてユーザー セグメントをターゲット設定できますが、その方法はサーバー API で to フィールドを使用する場合は利用できません。

Notifications コンソールからクライアントに送信される Key には次のものがあります。

キー コンソールのフィールド ラベル 説明
notification.title メッセージ タイトル 通知のタイトルを示します。
notification.body メッセージ文 通知の本文テキストを示します。
data カスタムデータ 定義した Key-Value ペア。これらのペアは、処理するアプリのデータ ペイロードとして配信されます。

メッセージの配信を決定する Key には次のものが含まれます。

キー コンソールのフィールド ラベル 説明
priority 優先度

メッセージの優先度を設定します。

詳細については、メッセージの優先順位の設定をご覧ください。

sound 通知音

端末が通知を受信したときに再生する通知音を示します。

time_to_live 有効期限

このパラメータでは、端末がオフラインの場合にメッセージを FCM のストレージに保持する期間(秒単位)を指定します。詳細については、メッセージの有効期間の設定をご覧ください。

通知を受信して処理する

アプリをフォアグラウンドで実行しているときに通知を受信できるようにするには、メッセージを処理するロジックをクライアント アプリケーションに追加する必要があります。

メッセージを受信するには、FirebaseMessagingService を拡張したサービスを使用します。サービスでは onMessageReceived コールバックをオーバーライドする必要があります。このコールバックは次の例外を除いて、ほとんどのメッセージ タイプに利用できます。

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

  • 通知とデータ ペイロードの両方を含む、バックグラウンドおよびフォアグラウンドのメッセージ。この場合、通知は端末の通知領域(システムトレイ)に配信され、データ ペイロードはランチャー アクティビティのインテントの追加部分で配信されます。

要約:

アプリの状態 通知 データ ペイロード 両方
フォアグラウンド onMessageReceived onMessageReceived onMessageReceived
バックグラウンド システムトレイ onMessageReceived 通知: システムトレイ
インテントの追加部分にあるデータ
メッセージ タイプについて詳しくは、通知とデータ メッセージをご覧ください。

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

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

 verbatim afbbdadfac56d27553ad7145fd2f135a <service
    android:name=".MyFirebaseMessagingService">
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT"/>
    </intent-filter>
</service> endverbatim afbbdadfac56d27553ad7145fd2f135a 

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

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

 verbatim 7c0551d3ab5f561315df20e0a10a20a3 <!-- 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" /> endverbatim 7c0551d3ab5f561315df20e0a10a20a3 

Android には、以下に関するカスタム デフォルト アイコンが表示されます。

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

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

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

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

onMessageReceived のオーバーライド

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

 verbatim d208264044a529634eef60dda369a08b @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());
    }

    // 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.
} endverbatim d208264044a529634eef60dda369a08b 

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

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

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

フィードバックを送信...