サーバー構築不要!スマートフォンアプリ向けの新クラウド

トップ >ドキュメント >プッシュ通知(Android):基本的な使い方

プッシュ通知(Android)

基本的な使い方

概要

このページでは、プッシュ通知の基本的な使い方について説明していきます。
こちらはAndroid SDK v3以降のドキュメントになります。
v2以前をご使用の方はこちらをご参照ください。

設定の流れ

ニフクラ mobile backendのプッシュ通知機能は、
Googleが提供しているFirebase Cloud Messaging(以下、FCM)と連携することで、通知の配信を行っています。

Androidアプリでプッシュ通知を受信するまでの設定は以下のような流れとなっています。

  1. Firebaseプロジェクトの作成とAPIキーの取得
  2. google-services.jsonとFirebase秘密鍵の設定
  3. ニフクラ mobile backendでの設定
  4. アプリでの設定

Firebaseプロジェクトの作成とAPIキーの取得

まず、ニフクラ mobile backendと連携させるためのAPIキーを取得する必要があります。
以下のドキュメントを参考に、Firebaseプロジェクトの作成とAPIキーの取得を行ってください。

google-services.jsonとFirebase秘密鍵の設定

FCM対応したプッシュ通知を送信する場合、google-services.jsonをアプリに配置してただくのと、Firebaseプロジェクトの秘密鍵をmobile backendにアップロードしていただく必要があります。
以下のドキュメントを参考に、google-services.jsonとFirebase秘密鍵の設定を行ってください。

ニフクラ mobile backendでの設定

次に、ニフクラ mobile backendでプッシュ通知の設定を行います。

プッシュ通知の有効化

アプリ設定から、左メニューのプッシュ通知の項目を選択してください。
プッシュ通知の許可設定を行う部分があるので、「許可する」に変更して変更を保存してください。

プッシュ通知の有効化

Firebaseプロジェクトで取得したAPIキーの追加

Firebaseプロジェクトで取得したAPIキー(サーバーキー)を設定し、変更を保存してください。

APIキーの追加

以上の設定で、ニフクラ mobile backendとFirebaseを連携することができました。
ここからは、アプリ側でプッシュ通知を受信するための実装を行っていきます。

アプリでの設定

アプリ側では、以下のような設定を行います。

  • google-services.jsonの配置
  • 必要なライブラリのインストール
  • AndroidManifestの編集
  • 端末をニフクラ mobile backendに登録する処理の実装

なお、ニフクラ mobile backendのAndroid SDKは
インストールと初期化が済んでいるものとして説明しますので、
未実施の場合はクイックスタートをご覧ください。

google-services.jsonの配置

もし、google-services.jsonとFirebase秘密鍵の設定を行った際、google-services.jsonをまだアプリに配置していない場合は、ここで配置してください。

ライブラリのインストール

プッシュ通知をmobile backendで送受信するためには、以下のライブラリが必要です。

  • Google Play Services SDK
    • プッシュ通知を受信するために必要です
  • Support Library
    • 通知を表示させるために必要です

これらのライブラリは以下の手順でインストールします

  • SDK Managerで必要なライブラリをインストールする
    • Android Support Library
    • Android Support Repository(Android Studioの場合)
    • Google Play Services
    • プロジェクトのbuild.gradleファイルを編集する
 buildscript {
     dependencies {
         classpath 'com.google.gms:google-services:3.2.1'
     }
 }

  • アプリケーションモジュールのbuild.gradleファイルを編集する
    • repositoriesに追加
repositories {
    maven {
        url 'https://maven.google.com'
    }
}

  • dependenciesに追加
dependencies {
    implementation 'com.android.support.constraint:constraint-layout:1.1.2'
    implementation 'com.android.support:support-annotations:27.1.1'
    implementation 'com.google.firebase:firebase-messaging:17.1.0'
    implementation 'com.google.android.gms:play-services-base:15.0.1'
    implementation 'com.google.code.gson:gson:2.3.1'
    compile files('libs/NCMB.jar')
}

apply plugin: 'com.google.gms.google-services'

詳細な手順については、Googleが提供しているドキュメントをご覧ください

Android Manifestの編集

AndroidManifest.xmlにて、利用するパーミッションの宣言と
レシーバー、サービスの登録を行います。

まずは、manifestタグの要素として以下のパーミッションの利用を宣言してください。
android.permission.VIBRATEが不要な場合は削除しても構いません。
パッケージ名は、各自のプロジェクトのものに適宜変更してください。

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.GET_ACCOUNTS" />
<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-permission android:name="android.permission.VIBRATE" />

次に、applicationタグの要素としてserviceの登録を行います。

  • serviceの登録
 <service
     android:name="com.nifcloud.mbaas.core.NCMBFirebaseMessagingService"
     android:exported="false">
     <intent-filter>
         <action android:name="com.google.firebase.MESSAGING_EVENT"/>
     </intent-filter>
 </service>

  • meta-dataの設定

v2以降から以下の項目がAndroidManifestで設定可能となりました。
プッシュ通知タップ時に起動するActivityの設定は必須の設定となります。

<!-- プッシュ通知タップ時に起動するActivityの設定 ※必須の設定 -->
<meta-data android:name="openPushStartActivity" android:value=".MainActivity"/>

<!-- 通知エリアに表示されるアイコンの設定 -->
<meta-data android:name="smallIcon" android:resource="@drawable/icon"/>

<!-- 通知エリアに表示されるアイコンカラーの設定 -->
<meta-data android:name="smallIconColor" android:value="@color/カラー名"/>

<!-- 通知エリアにプッシュ通知を複数表示する設定 0:最新のみ表示 , 1:複数表示 -->
<meta-data android:name="notificationOverlap" android:value="0"/>

<!-- カスタムダイアログプッシュを利用する場合のみ背景画像の設定 -->
<meta-data android:name="dialogPushBackgroundImage" android:resource="@drawable/balloon"/>

配信端末情報の登録

上記のプッシュ通知設定を行っている場合、NCMB.initializeを書くだけで配信端末情報を登録することができます。
MainActivity.javaのonCreateに書く場合は以下のようになります。

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // APIキーの設定とSDK初期化、配信端末の登録
    NCMB.initialize(this.getApplicationContext(), "APP_KEY", "CLIENT_KEY");

    setContentView(R.layout.activity_main);
}

アプリの再インストールを考慮する場合

Android SDK v3からはエラーが発生しなくなるので、特別な対応は必要はありません。
再インストールされた場合、端末情報の更新をSDKの内部処理で行います。

installationが削除された時を考慮する場合

Android SDK v3からはエラーが発生しなくなるので、特別な対応は必要はありません。

以下の例のように、何らかの理由により有効な installation が削除されてしまう場合があります。
Androud SDK v3からは端末情報の再登録をSDKの内部処理で行います。

  • 管理者の操作ミスによる削除
    • コントロールパネル上の操作ミスなど
  • 管理者が意図しない操作による削除

以上でアプリ側での設定は完了です。
アプリをAndroid端末で実行し、端末情報がデータストアに登録されるか確認してください。

プッシュ通知をアプリから送信する

ダッシュボードだけでなく、アプリからも他の端末へプッシュ通知を送信することができます。
deliveryTime未設定の場合は即時配信設定になります。

プッシュ通知の設定を行う
  • iOS端末へのプッシュ通知を行う場合は、バッジの増加フラグや、着信音の設定などが可能です。
private void sendPush() throws JSONException {
    NCMBPush push = new NCMBPush();
     push.setBadgeIncrementFlag(true);
     push.setSound("default");
     push.setCategory("CATEGORY001");
     push.setTarget(new JSONArray("[ios]"));
     push.setMessage("send push!");
     push.sendInBackground(new DoneCallback() {
         @Override
         public void done(NCMBException e) {
             if (e != null) {
                 // エラー処理
             } else {
                 // プッシュ通知登録後の処理
             }
         }
     });
}

  • Android端末へのプッシュ通知を行う場合は、タイトルや起動画面、ダイアログプッシュ通知の有効フラグを設定できます。
private void sendPush() throws JSONException {
    NCMBPush push = new NCMBPush();
    push.setAction("com.sample.pushsample.RECEIVE_PUSH");
    push.setTitle("test title");
    push.setMessage("send push!");
    push.setTarget(new JSONArray("[android]"));
    push.setDialog(true);
    push.sendInBackground(new DoneCallback() {
        @Override
        public void done(NCMBException e) {
            if (e != null) {
                // エラー処理
            } else {
                // プッシュ通知登録後の操作
            }
        }
    });
}

プッシュ通知のスケジューリング

プッシュ通知の配信時刻を指定することができます。

Date date = new Date();
date.setTime(date.getTime() + 60 * 60 * 3 * 1000);//3時間後に設定

NCMBPush push = new NCMBPush();
push.setMessage("test Push Notification");
push.setDeliveryTime(date);
push.sendInBackground();

配信端末の絞り込み

setSearchConditionメソッドでクエリを設定することにより、
プッシュ通知を配信する端末を絞り込むことができます。
端末情報をmobile backendに登録する時に任意の値を設定可能ですので、
installationクラスの既存フィールド以外でも絞り込み条件を設定することができます。

以下はsetChannelsメソッドを使用して、channelsフィールドに絞込み条件として["Ch1"]を設定する例です。

private void setChannel(){
    NCMBInstallation installation = NCMBInstallation.getCurrentInstallation();
    JSONArray channels = new JSONArray();
    channels.put("Ch1");
    installation.setChannels(channels);
    installation.saveInBackground(new DoneCallback() {
        @Override
        public void done(NCMBException e) {
            if (e != null) {
                //エラー発生時の処理
            } else {
                //成功時の処理
            }
        }
    });
}

channelsに"Ch1"が設定されている端末に絞り込んだプッシュ通知は、以下のように配信できます。

private void testPushWithSearchCondition(){
    NCMBPush push = new NCMBPush();
    NCMBQuery<NCMBInstallation> query = new NCMBQuery<>("installation");
    query.whereEqualTo("channels", "Ch1");
    push.setSearchCondition(query);
    push.setMessage("test SearchCondition");
    push.sendInBackground();
}

ダッシュボードからプッシュ通知を配信する

ここからは、ダッシュボードからプッシュ通知を配信する方法を説明します。

プッシュ通知を送信する

ダッシュボード左側メニューのプッシュ通知をクリックし、プッシュ通知の画面を開きます。

新しいプッシュ通知ボタンをクリックすると、プッシュ通知作成画面が表示されます。
このページで新たなプッシュ通知を作成できます。タイトル、メッセージ、JSONデータを記入してください。
※プッシュ通知の設定でメッセージとタイトルを入力しなかった場合は、端末にプッシュ通知が表示されません。
(上記の場合でも、ダイアログ表示やJSONデータの取得は可能です。)
※iOS宛プッシュ通知の設定は、iOS8未満は合計256バイトまで、iOS8以降は合計2Kバイトまでがサポート対象となります。
新規プッシュ通知作成

配信日時の指定を行います。以下の例では、作成されたプッシュ通知が即時に配信される設定になっています。

プッシュ通知送信日時を指定する場合は、配信日時の欄で日時を選択し、希望する日時を指定してください。

配信期限の指定では電源が切れているなどの事情により通知を受け取れなかった端末への再送信期間を設定できます。デフォルトの設定では再送信できる期間が10日間となっていますが1~28日間、1~24時間の間で、期間を指定できます。

また、配信期限を日時で指定する場合は、日時の指定画面が表示されます。

次に、配信を行うプラットフォームを選択してください。AndroidとiOSの両方にプッシュ通知を送信することも可能です。
Androidを選択した場合は、以下のようにアクション設定と、ダイアログ表示の設定画面が表示されます。
Android独自設定

iOSを選択した場合は、以下のようなiOS端末へのプッシュ通知を行うための設定画面が開きます。
iOS独自設定

最後に「プッシュ通知を作成する」ボタンをクリックすると、プッシュ通知が作成されます。

プッシュ通知でJSONデータを取得する

プッシュ通知にはJSON形式で任意のデータを含めることができるので、
プッシュ通知を受信した時に、そのデータを受け取って処理を行うことができます。

カスタムサービスを用意

SDKが用意しているNCMBFirebaseMessagingServiceを継承して、
カスタムサービスを作成してください。

AndroidManifest.xmlのサービスを定義している部分を書き換えてください。

<service
    android:name="com.nifcloud.mbaas.core.CustomFirebaseMessagingService"
    android:exported="false">
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT"/>
    </intent-filter>
</service>

JSONデータの取得を実装

CustomFirebaseMessagingServiceクラスでonMessageReceivedメソッドをオーバーライドして、
プッシュ通知に含まれているJSONデータを取得します。

@Override
public void onMessageReceived(com.google.firebase.messaging.RemoteMessage remoteMessage) {
    //ペイロードデータの取得
    Log.d(TAG, String.valueOf(remoteMessage.getData()));

    //デフォルトの通知
    super.onMessageReceived(remoteMessage);
}

ペイロードの内容について

Android端末へのプッシュ通知では、以下のペイロードが受信されます。

パラメータ名 説明 データ型
com.nifty.PushId プッシュ通知ID 文字列
com.nifty.Data ユーザー設定値 オブジェクト
com.nifcloud.mbaas.PushId プッシュ通知ID 文字列
com.nifcloud.mbaas.Data ユーザー設定値 オブジェクト
title タイトル 文字列
message メッセージ 文字列
action アクション 文字列
com.nifty.Channel チャネル 文字列
com.nifty.Dialog ダイアログ 1(固定)
com.nifty.RichUrl リッチプッシュ通知用URL 文字列
com.nifcloud.mbaas.Channel チャネル 文字列
com.nifcloud.mbaas.Dialog ダイアログ 1(固定)
com.nifcloud.mbaas.RichUrl リッチプッシュ通知用URL 文字列
  • com.nifty.* 系(com.nifty.PushIdなど)は2019年9月廃止予定のパラメータです。
    • Android SDKをv3.0.0以上にして、com.nifcloud.mbaas.* 系(com.nifcloud.mbaas.PushId)を使用してください。
JSONデータのパラメータに使用可能な文字の制限

JSONデータのパラメータには、以下の文字が使用できません。

  1. ダブルクォーテーション「"」
  2. ドット「.」
  3. 先頭にドル記号「$」







お探しの内容が見つからなかった場合はユーザーコミュニティ もご活用ください。(回答保証はいたしかねます)
なお、 Expertプラン以上のお客様はテクニカルサポートにてご質問を承らせて頂きます。

推奨画面サイズ1024×768px以上

ページの先頭へ