プッシュ通知（Android）¶
ReproではGCMまたはFCMをご利用いただけます。
プッシュ通知の設定 (Android)¶
Reproからプッシュ通知を送るには、GCM/FCMを利用するためのAPIキーを Firebase Console から生成し、Reproに登録する必要があります。
APIキーの生成¶
プロジェクト設定 を選択してください。
クラウドメッセージング タブを選択し、サーバーキー をコピーしてください。また、この時出力される 送信者ID も後から使用しますのでメモをしておいてください。
AndroidManifest.xmlファイルを編集する¶
パーミッションの追加¶
以下のXML中の “YOUR_PACKAGE_NAME” をアプリケーションのパッケージ名に置き換え、AndroidManifest.xmlの <application> タグの直前に追加してください。
<uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />
<permission android:name="YOUR_PACKAGE_NAME.permission.C2D_MESSAGE" android:protectionLevel="signature" />
<uses-permission android:name="YOUR_PACKAGE_NAME.permission.C2D_MESSAGE" />
Android4.0.4以前の機種でプッシュ通知を利用する場合は、さらに <uses-permission android:name="android.permission.GET_ACCOUNTS" android:maxSdkVersion="18" /> を追加してください。
注釈
FCMをご利用の場合はパーミッションの追加は不要です。
Receiverの登録¶
以下のXML中の “YOUR_PACKAGE_NAME” をアプリケーションのパッケージ名に置き換え、AndroidManifest.xmlの <application> タグの中に追加してください。
<receiver
android:name="io.repro.android.GCMReceiver"
android:exported="true"
android:permission="com.google.android.c2dm.permission.SEND">
<intent-filter>
<action android:name="com.google.android.c2dm.intent.RECEIVE" />
<category android:name="YOUR_PACKAGE_NAME" />
</intent-filter>
</receiver>
Eclipse ADTをお使いの方は Receiverの登録 をご覧ください。
アイコンと背景色のカスタマイズ¶
Android5.0以降の機種で、通知エリアに表示されるアイコンとその背景色をカスタマイズする場合は、以下のXMLをAndroidManifest.xmlの <application> タグの中に追加してください。Android5.0未満の機種では以下の設定は無視され、通知エリアにはアプリケーションのアイコンおよびシステムデフォルトの背景色が使用されます。
<meta-data
android:name="io.repro.android.PushNotification.SmallIcon"
android:resource="@drawable/YOUR_ICON_ID">
</meta-data>
<meta-data
android:name="io.repro.android.PushNotification.AccentColor"
android:resource="@color/YOUR_COLOR_ID">
</meta-data>
通知チャンネルの設定¶
Android Oにて、ユーザーが通知を管理できるように通知チャンネルが導入されました。
Repro SDKで利用する通知チャンネルの設定を行うには、「ID」「名前」「ユーザー向けの説明」「badgeの表示有無」を以下のようにアプリのAndroidManifest.xmlで指定してください。IDと名前の指定は必須、その他は省略可能です。「ユーザー向けの説明」省略時は空文字列、「badgeの表示有無」省略時はbadgeの表示有りとなります。
警告
- アプリのtargetSDKVersionが26以上かつAndroid O以降の機種で動作させる場合、IDと名前が指定されていなければSDKはReproからのプッシュ通知を表示いたしませんのでご注意ください。
<meta-data
android:name="io.repro.android.PushNotification.ChannelId"
android:value="YOUR_CHANNEL_ID">
</meta-data>
<meta-data
android:name="io.repro.android.PushNotification.ChannelName"
android:resource="@string/YOUR_CHANNEL_NAME">
</meta-data>
<meta-data
android:name="io.repro.android.PushNotification.ChannelDescription"
android:resource="@string/YOUR_CHANNEL_DESCRIPTION">
</meta-data>
<meta-data
android:name="io.repro.android.PushNotification.ShowBadge"
android:value="true">
</meta-data>
指定されたIDの通知チャンネルが存在しない場合はAndroidManifest.xmlの指定を基にSDKが自動で作成し、指定されたIDの通知チャンネルが存在する場合は既存のものを利用します。
既存のものを利用する場合、SDKは「名前」と「ユーザー向けの説明」を更新します。
また、アプリのtargetSDKVersionが25以下の場合、あるいは、Android O未満の機種の場合は、SDKは上記の通知チャンネルに関する設定を無視します。
注釈
通知チャンネルはAndroid Oで導入されたAndroidの標準機能です。通知チャンネルの詳細は こちら をご覧ください。
GCMをご利用の場合¶
Google Play Servicesへの依存関係を追加¶
アプリケーションのbuild.gradleに以下を追加してください。
dependencies {
implementation "com.google.android.gms:play-services-gcm:15.0.1"
}
- Eclipse ADTをお使いの方は Google Play Servicesへの依存関係を追加 をご覧ください。
警告
Gradle 3.4 未満のバージョンの場合は ‘implementation’ が利用できません。 ‘compile’を利用してください。
注釈
サポート対象のGoogle Play Services SDKは3.1.36以降です。
注釈
Google Play Servicesへの依存を追加することにより、アプリケーションから参照されるメソッド数が65536個を超える可能性があります。その場合アプリケーションのMultiDex化が必要です。MultiDex化の詳細については こちら をご覧ください。
Registration IDをReproに送信¶
Registration IDをReproに送信するには、 enablePushNotification() APIを呼び出す必要があります。このAPIは引数として 送信者ID(SENDER_ID) を受け取ります。
Reproの setup() を呼び出した直後に、先程取得した 送信者ID(SENDER_ID) を指定して enablePushNotification() を呼び出します。
import io.repro.android.Repro;
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
...
Repro.setup(this, "YOUR_APP_TOKEN");
Repro.enablePushNotification("SENDER_ID");
...
}
}
FCMをご利用の場合¶
アプリにFirebaseを導入する¶
AndroidプロジェクトにFirebaseを追加する の手順に従ってアプリにFirebaseを導入してください。その後、アプリのbuild.gradleに以下を追加してください。
dependencies {
implementation "com.google.firebase:firebase-messaging:10.0.1"
}
警告
Gradle 3.4 未満のバージョンの場合は ‘implementation’ が利用できません。 ‘compile’を利用してください。
Registration IDをReproに送信¶
Reproの setup() を呼び出した直後に、 FirebaseInstanceId.getInstance().getToken() で取得したRegistration IDを指定して Repro.setPushRegistrationID を呼び出してください。
import io.repro.android.Repro;
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
...
Repro.setup(this, "YOUR_APP_TOKEN");
String token = FirebaseInstanceId.getInstance().getToken();
Repro.setPushRegistrationID(token);
...
}
}
FirebaseInstanceIdService を継承したクラスの onTokenRefresh にて Repro.setPushRegistrationID を呼び出してください。
import io.repro.android.Repro;
public class MyFirebaseInstanceIDService extends FirebaseInstanceIdService {
...
@Override
public void onTokenRefresh() {
String refreshedToken = FirebaseInstanceId.getInstance().getToken();
Repro.setPushRegistrationID(refreshedToken);
}
...
}
以下をAndroidManifest.xmlの <application> タグの中に追加してください。
<service
android:name=".MyFirebaseInstanceIDService">
<intent-filter>
<action android:name="com.google.firebase.INSTANCE_ID_EVENT"/>
</intent-filter>
</service>
プッシュ通知受信時の動作をカスタマイズする¶
プッシュ通知受信時の動作をカスタマイズしたい場合は、アプリケーション独自のGCMReceiverを実装してください。
GCMReceiverを実装する¶
io.repro.android.GCMReceiver を継承したクラスを作成し、onReceive をオーバーライドしてください。 スタンダード形式のメッセージ の通知は super.onReceive で作成されます。 カスタム (JSON)形式のメッセージ の通知を作成する処理は super.onReceive の後に実装してください。
package your.package.name;
import android.content.Context;
import android.content.Intent;
public class GCMReceiver extends io.repro.android.GCMReceiver {
@Override
public void onReceive(Context context, Intent intent) {
super.onReceive(context, intent);
Bundle extras = intent.getExtras();
// check whether the application should handle this push notification.
if (!Repro.applicationShouldHandlePushNotification(context, extras)) {
Log.d(TAG, "Ignore push notification: it will be handled by Repro SDK");
return;
}
// check whether this push notification was already received.
if (Repro.isAlreadyReceivedPushNotification(context, extras)) {
Log.d(TAG, "Ignore push notification: it was already received");
return;
}
// mark this push notification as "received".
Log.d(TAG, "Mark push notification as received");
Repro.markPushNotificationReceived(context, extras);
// Implement procedures unique to the application here
...
}
}
注釈
Repro.applicationShouldHandlePushNotificationを呼び出して、受信したメッセージをアプリケーションで処理すべきか判定してください。このメソッドがfalseを返す場合、そのメッセージはSDKで処理されます。Repro.isAlreadyReceivedPushNotificationを呼び出して、受信済みのメッセージか判定してください。アプリケーションのアンインストール・再インストールを繰り返した場合、重複したメッセージが届く場合があります。Repro.markPushNotificationReceivedを呼び出して、受信済みのメッセージであることを記録してください。
AndroidManifest.xmlファイルを編集する¶
Receiverの登録 で追加したreceiverの定義を以下に置き換えてください。これにより、アプリケーション独自のGCMReceiverがメッセージを受信できるようになります。
<receiver
android:name="your.package.name.GCMReceiver"
android:exported="true"
android:permission="com.google.android.c2dm.permission.SEND">
<intent-filter>
<action android:name="com.google.android.c2dm.intent.RECEIVE" />
<category android:name="your.package.name" />
</intent-filter>
</receiver>
開封された通知をトラッキングする¶
テキスト形式のメッセージの場合はSDKが自動で開封をトラッキングします。JSON形式のメッセージの場合は、アプリケーションから Repro.trackNotificationOpened を呼び出してトラッキングする必要があります。
以下では、JSON形式のメッセージからActivityを起動する通知を作成し、起動されたActivity側で Repro.trackNotificationOpened を呼び出すサンプルを示します。
public class GCMReceiver extends io.repro.android.GCMReceiver {
private static final String TAG = "GCMReceiver";
@Override
public void onReceive(Context context, Intent intent) {
super.onReceive(context, intent);
Bundle extras = intent.getExtras();
// check whether the application should handle this push notification.
if (!Repro.applicationShouldHandlePushNotification(context, extras)) {
Log.d(TAG, "Ignore push notification: it will be handled by Repro SDK");
return;
}
// check whether this push notification was already received.
if (Repro.isAlreadyReceivedPushNotification(context, extras)) {
Log.d(TAG, "Ignore push notification: it was already received");
return;
}
// mark this push notification as "received".
Log.d(TAG, "Mark push notification as received");
Repro.markPushNotificationReceived(context, extras);
String message;
if (extras.containsKey("message")) {
message = extras.getString("message");
} else {
message = "default message";
}
final Notification.Builder builder = new Notification.Builder(context)
.setContentTitle(context.getResources().getString(R.string.app_name))
.setContentText(message)
.setSmallIcon(R.drawable.ic_launcher)
.setAutoCancel(true);
Intent resultIntent = new Intent(context, SomeActivity.class);
resultIntent.putExtras(extras);
PendingIntent resultPendingIntent = PendingIntent.getActivity(context, 0, resultIntent, PendingIntent.FLAG_CANCEL_CURRENT);
builder.setContentIntent(resultPendingIntent);
final NotificationManager notificationManager = (NotificationManager)context.getSystemService(Context.NOTIFICATION_SERVICE);
notificationManager.notify(0, builder.getNotification());
}
}
起動されたActivity側では、上述の resultIntent にセットしたExtrasからプッシュ通知IDを取得し、 onResume で Repro.trackNotificationOpened にセットしてください。なおアクティビティのローンチモードが singleTop の場合は、 onNewIntent で同様にプッシュ通知IDをセットしてください。
public class SomeActivity extends Activity {
@Override
protected void onResume() {
super.onResume();
Intent intent = getIntent();
Bundle extras = intent.getExtras();
if (extras != null && extras.containsKey(io.repro.android.GCMReceiver.NOTIFICATION_ID_KEY)) {
Repro.trackNotificationOpened(extras.getString(io.repro.android.GCMReceiver.NOTIFICATION_ID_KEY));
}
}
@Override
protected void onNewIntent(Intent intent) {
super.onNewIntent(intent);
Bundle extras = intent.getExtras();
if (extras != null && extras.containsKey(io.repro.android.GCMReceiver.NOTIFICATION_ID_KEY)) {
Repro.trackNotificationOpened(extras.getString(io.repro.android.GCMReceiver.NOTIFICATION_ID_KEY));
}
this.setIntent(intent);
}
注釈
- プッシュ通知IDは、受信したメッセージのBundleから
io.repro.android.GCMReceiver.NOTIFICATION_ID_KEYというキーで取得できます。
上記の実装が終わったら、 プッシュ通知を作成する をご覧ください。