本記事では、b→dash mobile SDK(Android用)でPush配信を行うための実装方法について紹介しています。
実装手順は、大きく下記の4つです。

　1. Push通知の実装イメージと通知タイプ
　2. Push通知を導入する
　3. Push通知を利用する
　4. Push通知からアプリを起動する

各手順の詳細は、以下をご参照ください。

1. Push通知の実装イメージ

b→dash mobile SDKでは、Push配信時に「通知パラメーター」というデータを指定することで、配信から遷移する表示画面を変えるなどの制御が可能です。内部のPush通知サービスとしてFirebase Cloud Messaging(FCM)を利用しています。

通知タイプの種類

本SDKでは、エンドユーザーへのPush通知として下記の3パターンとサイレント通知を用意しており、現行のSDKでは「標準通知」のみをサポートしています。

※ Push通知は「ユーザー操作に割り込んで通知する」「アプリを起動しなくても通知する」という強いメッセージ性を持つため、適切なタイミングでの利用が重要です。Googleは下記4点を重視しています:
　1. エンドユーザーがオフにできるようにする
　2. 単なる広告の表示は避ける
　3. エンドユーザー自身に直接関係のある情報を優先して表示する
　4. 提供者視点ではなくエンドユーザー視点で通知の内容、タイミング、頻度、プライオリティを調整する

受信イメージ

Android端末で「Push通知」を受信したときのイメージを、「Push通知」「リッチ通知(画像付きPush通知)」の場合でそれぞれご紹介します。

※ OSのバージョンや機種によって見栄えが異なる場合があります

2. Push通知を導入する

事前準備とFirebase Console設定

Push通知を利用するにはGoogleアカウントが必要です。事前に用意し、Firebase Consoleで「サーバーキー」を発行してください。

※ 詳細はFirebase公式ドキュメントもご参照ください

Firebase Consoleで任意のプロジェクトを作成し、ダウンロードしたgoogle-service.jsonをプロジェクトのappディレクトリに組み込みます。

起動アクティビティの設定

Push通知を受け取った時、標準ではandroid.intent.category.LAUNCHERのActivityが起動します。独自に指定する場合は、下記の<meta-data>をmanifestの<application>内に追加します。

● 記載例:
　<meta-data android:name="com.f_scratch.bdash.mobile.push.launch" android:value="パッケージ名も含めてActivityを指定します" />

受信時のアイコンの設定

デフォルトではアプリケーション組み込みのアイコンが利用されますが、サイズ差異によるイメージ崩れを防ぐためにmanifestで定義することを推奨します。

通知チャンネルの設定

通知チャンネルを有効にするためには、下記の必須設定をmanifestで定義する必要があります。最初に作成後、通知チャンネル名/説明の更新は可能ですが、通知の重要度などはAPIを通して変更できません(変更には既存チャンネルの削除と再作成が必要)。

組み込みの設定画面

Android版では組み込みの「Push通知の設定画面」を3種類のデザインテーマで用意しています。

※ APIレベル26(Android 8.0)以降は「通知チャンネル」が導入されたため、本機能はAndroid 7.0以下で利用することを想定しています。Android 8.0については、「アプリ設定」の通知設定で切り替えます
　 言語は「日本語」と「英語」の2言語に対応
　 デザインテーマはお客様の方でオーバーライド可能(parent属性に「BDashSDK_Theme」を指定し、ヘッダカラー色の要素「colorPrimary」を上書き)

Push受信サービスの競合への対応(FCM導入済みの場合)

Push通知の受信処理に独自のペイロード解析を行っている場合、Androidでは「FirebaseMessagingService」クラスを継承して実装します。b→dash Mobile SDKでは上記のクラスを継承しmanifestで定義しているため、この定義はmanifest内に1つしか定義できず、アプリで定義するとSDKの定義が上書きされb→dashの通知受信が行われなくなります。

アプリとSDK双方で受信できるように、「アプリ側でb→dash受信クラスを継承し処理を切り分ける」対応が必要です(FCMReceiverServiceを継承し、メッセージ種別によって処理メソッドを分ける)。

※「b→dashの通知と判断」する場合、第二引数dataのペイロードの中に「jp_co_fscratch」というキーが定義されているのでそちらをご利用ください(値は無視可能)

3. Push通知を利用する

ログ取得用API

Push通知を利用するために計測ログとしてFCMトークンを送信する必要があります。Push通知で利用するAPIは下記です。

※ FCMトークンの値は、b→dash SDKが提供するプロパティ BDashNotification.getToken() からも取得可能です

Push通知用API

BDashNotificationクラスで公開されているAPIの主要なものは下記です(★は登録/解除を行う主要API)。

Push通知の有効/無効化

Push通知を有効/無効にするには、それぞれ下記のコードを呼び出します。

BDashNotification bdashNotification = Tracker.getInstance(this).getNotification();
bdashNotification.addStateListener(new BDashNotification.NotificationStateListener() {
    @Override public void onEnable() { /* 通知有効時 */ }
    @Override public void onDisable() { /* 通知無効時 */ }
    @Override public void onError(int i, Throwable throwable) { /* エラー発生時 */ }
});
bdashNotification.registerNotification();  // 有効化 (無効化は cancelNotification())

※ 通知の登録結果はaddStateListener()に登録したリスナーに通知されます。通信エラーやFCM内部エラー発生時はonErrorとして通知されるため、リトライ処理やユーザーへの促しを考慮してください
　 リスナーは登録を解除しない限り生存するため、removeStateListener()で必要に応じて削除する必要があります

トークンリフレッシュのリスナー

トークンを取得したタイミングで処理を行いたい場合、BDashNotification.FCMTokenRefreshListenerを使うことで適切なタイミングで取得可能です。ほとんどのアプリでは本実装は必須になります。

※ onRefreshToken()はアプリケーションのタスクが新規起動するたびに呼び出されます
　 トークンが変わったときに同期を行う場合は、変わったことを検知できるようにトークンを独自に保存し、比較を行った上でregisterForceNotification()を呼ぶ必要があります

サウンド・バイブレーションのON/OFF

Android 8.0以降では、サウンド・バイブともに「通知チャンネルにてデフォルトでON」となります。Android 8.0未満では下記メソッドで制御可能ですが、現在は動作保証されていません。

bdashNotification.setEnableSound(true);      // サウンド有効
bdashNotification.setEnableVibration(true);  // バイブ有効
// false で無効化

4. Push通知からアプリを起動する

エンドユーザーが受信した通知をタップした時、「起動アクティビティ」で設定したActivityが起動されます。通知から遷移した時に含まれる「起動パラメーター」を利用した判定や、成果としてTracking情報を送るには、起動したActivityのonCreate()で下記のように送信します。

Intent intent = getIntent();
int isNotification = intent.getIntExtra(BDashNotification.LAUNCH_NOTIFICATION, 0);
if (isNotification != 0) {
    String param = intent.getStringExtra(BDashNotification.LAUNCH_EXTRA_PARAM);
    if (param != null) {
        param = URLDecoder.decode(param, "UTF-8");  // URLデコード
        // 起動パラメーターを判断して画面遷移
    }
    // Tracking情報を生成
    Tracker.getInstance(this).setBootType(Tracker.BootType.BOOT_PUSH, param);
    Tracker.getInstance(this).setScreenName("任意のスクリーン名");
    Tracker.getInstance(this).send(new ScreenViewBuilder().build());
}

Push通知の実装における重要な注意事項