プッシュ通知をカスタマイズする

前提条件

この機能を使用する前に、Android Braze SDKを統合する必要があります。 プッシュ通知の設定も必要です。

プッシュイベント用のコールバックを使用する

Brazeには、プッシュ通知が受信されたとき、開かれたとき、または却下されたときのためのsubscribeToPushNotificationEvents()コールバックが用意されています。アプリケーションが実行されていないときに発生するイベントを見逃さないように、このコールバックをApplication.onCreate()に配置することをお勧めします。

注

以前にアプリケーションでこの機能にカスタムブロードキャストレシーバーを使用していた場合は、この統合オプションを優先して、レシーバーを安全に削除できます。

• java
• kotlin

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

Braze.getInstance(context).subscribeToPushNotificationEvents(event -> {
  final BrazeNotificationPayload parsedData = event.getNotificationPayload();

  //
  // The type of notification itself
  //
  final boolean isPushOpenEvent = event.getEventType() == BrazePushEventType.NOTIFICATION_OPENED;
  final boolean isPushReceivedEvent = event.getEventType() == BrazePushEventType.NOTIFICATION_RECEIVED;
  // Sent when a user has dismissed a notification
  final boolean isPushDeletedEvent = event.getEventType() == BrazePushEventType.NOTIFICATION_DELETED;

  //
  // Notification data
  //
  final String pushTitle = parsedData.getTitleText();
  final Long pushArrivalTimeMs = parsedData.getNotificationReceivedTimestampMillis();
  final String deeplink = parsedData.getDeeplink();

  //
  // Custom KVP data
  //
  final String myCustomKvp1 = parsedData.getBrazeExtras().getString("my first kvp");
  final String myCustomKvp2 = parsedData.getBrazeExtras().getString("my second kvp");
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

Braze.getInstance(context).subscribeToPushNotificationEvents { event ->
    val parsedData = event.notificationPayload

    //
    // The type of notification itself
    //
    val isPushOpenEvent = event.eventType == BrazePushEventType.NOTIFICATION_OPENED
    val isPushReceivedEvent = event.eventType == BrazePushEventType.NOTIFICATION_RECEIVED
    // Sent when a user has dismissed a notification
    val isPushDeletedEvent = event.eventType == BrazePushEventType.NOTIFICATION_DELETED

    //
    // Notification data
    //
    val pushTitle = parsedData.titleText
    val pushArrivalTimeMs = parsedData.notificationReceivedTimestampMillis
    val deeplink = parsedData.deeplink

    //
    // Custom KVP data
    //
    val myCustomKvp1 = parsedData.brazeExtras.getString("my first kvp")
    val myCustomKvp2 = parsedData.brazeExtras.getString("my second kvp")
}

ヒント

通知アクションボタンを使用すると、opens appまたはdeep linkアクションを持つボタンがクリックされたときにBRAZE_PUSH_INTENT_NOTIFICATION_OPENEDインテントが起動します。ディープリンクとエクストラの処理は変わりません。closeアクション付きのボタンはBRAZE_PUSH_INTENT_NOTIFICATION_OPENEDインテントを起動せず、通知を自動的に閉じます。

重要

Application.onCreateでプッシュ通知リスナーを作成し、アプリが終了状態にある間にエンドユーザーが通知をタップした場合でもリスナーがトリガーされるようにしてください。

通知表示のカスタマイズ

ステップ1:カスタム通知ファクトリーを作成する

サーバー側では面倒な方法や利用できない方法でプッシュ通知をカスタマイズしたい場合があります。通知表示を完全に制御できるように、独自のIBrazeNotificationFactoryを定義してBrazeで表示する通知オブジェクトを作成する機能が追加されました。

カスタムのIBrazeNotificationFactoryが設定されている場合、ユーザーに通知が表示される前に、プッシュ受信時にBrazeがファクトリーのcreateNotification()メソッドを呼び出します。Brazeは、Brazeプッシュデータを含むBundleと、ダッシュボードまたはメッセージングAPI経由で送信されたカスタムのキーと値のペアを含む別のBundleを渡します。

Brazeは、Brazeプッシュ通知からのデータを含むBrazeNotificationPayloadを渡します。

• java
• kotlin

1
2
3
4
5
6
7
8
9

// Factory method implemented in your custom IBrazeNotificationFactory
@Override
public Notification createNotification(BrazeNotificationPayload brazeNotificationPayload) {
  // Example of getting notification title
  String title = brazeNotificationPayload.getTitleText();

  // Example of retrieving a custom KVP ("my_key" -> "my_value")
  String customKvp = brazeNotificationPayload.getBrazeExtras().getString("my_key");
}

1
2
3
4
5
6
7
8

// Factory method implemented in your custom IBrazeNotificationFactory
override fun createNotification(brazeNotificationPayload: BrazeNotificationPayload): Notification {
  // Example of getting notification title
  val title = brazeNotificationPayload.getTitleText()

  // Example of retrieving a custom KVP ("my_key" -> "my_value")
  val customKvp = brazeNotificationPayload.getBrazeExtras().getString("my_key")
}

カスタムのcreateNotification()メソッドからnullを返して通知をまったく表示しないことも、BrazeNotificationFactory.getInstance().createNotification()を使用してそのデータのデフォルトのnotificationオブジェクトを取得し、表示前に変更することも、完全に別個のnotificationオブジェクトを生成して表示することもできます。

注

Brazeのプッシュデータキーに関するドキュメントは、Android SDKを参照してください。

ステップ2:カスタム通知ファクトリーを設定する

Brazeにカスタム通知ファクトリーを使用するように指示するには、setCustomBrazeNotificationFactoryメソッドを使用してIBrazeNotificationFactoryを設定します。

• java
• kotlin

1

setCustomBrazeNotificationFactory(IBrazeNotificationFactory brazeNotificationFactory);

1

setCustomBrazeNotificationFactory(brazeNotificationFactory: IBrazeNotificationFactory)

カスタムIBrazeNotificationFactoryを設定する場所として推奨されるのは、Application.onCreate()アプリケーションライフサイクルメソッド（アクティビティではない）です。これにより、アプリプロセスがアクティブなときはいつでも通知ファクトリーが正しく設定されます。

重要

ゼロから独自の通知を作成するのは高度なユースケースであり、十分なテストとBrazeのプッシュ機能に対する深い理解がある場合にのみ行うべきです。たとえば、通知がプッシュ開封を正しくログに記録することを確認する必要があります。

カスタムIBrazeNotificationFactoryの設定を解除し、プッシュのデフォルトのBraze処理に戻すには、カスタム通知ファクトリーセッターにnullを渡します。

• java
• kotlin

1

setCustomBrazeNotificationFactory(null);

1

setCustomBrazeNotificationFactory(null)

マルチカラーテキストのレンダリング

Braze SDKバージョン3.1.1では、HTMLをデバイスに送信してプッシュ通知でマルチカラーテキストをレンダリングできます。

この例は、以下のHTMLでレンダリングされています。

1
2
3

<p><span style="color: #99cc00;">M</span>u<span style="color: #008080;">lti</span>Colo<span style="color: #ff6600;">r</span> <span style="color: #000080;">P</span><span style="color: #00ccff;">u</span><span style="color: #ff0000;">s</span><span style="color: #808080;">h</span></p>

<p><em>test</em> <span style="text-decoration: underline; background-color: #ff6600;"><strong>message</strong></span></p>

Androidでは、プッシュ通知で使用できるHTML要素とタグに制限があることに注意してください。たとえば、marquee は使用できません。

重要

マルチカラーテキストのレンダリングはデバイスに依存しており、Androidデバイスやバージョンによっては表示されない場合があります。

プッシュ通知でマルチカラーテキストをレンダリングするには、braze.xml または BrazeConfig を更新します。

• braze.xml
• brazeconfig

1

<bool translatable="false" name="com_braze_push_notification_html_rendering_enabled">true</bool>

1
2
3
4

BrazeConfig brazeConfig = new BrazeConfig.Builder()
  .setPushHtmlRenderingEnabled(true)
  .build();
Braze.configure(this, brazeConfig);

1
2
3
4

val brazeConfig = BrazeConfig.Builder()
    .setPushHtmlRenderingEnabled(true)
    .build()
Braze.configure(this, brazeConfig)

サポートされているHTMLタグ

現在、GoogleはAndroid向けのサポートされているHTMLタグをドキュメントに直接記載していません—この情報はGitリポジトリのHtml.javaファイルでのみ確認できます。以下の表を参照する際はこの点に留意してください。この情報は上記ファイルから取得したものであり、サポートされているHTMLタグは変更される可能性があります。

インライン画像のレンダリング

仕組み

Androidプッシュ通知でインライン画像プッシュを使用すると、より大きな画像を表示できます。このデザインでは、ユーザーが画像を拡大するためにプッシュ通知を手動で展開する必要がありません。通常のAndroidプッシュ通知とは異なり、インライン画像プッシュの画像は3:2のアスペクト比で表示されます。

互換性

インライン画像はどのデバイスにも送信できますが、最小バージョンの要件を満たさないデバイスやSDKでは、標準の画像が代わりに表示されます。インライン画像を正しく表示するには、Android Braze SDK v10.0.0以降と、Android M以降を搭載したデバイスの両方が必要です。また、画像をレンダリングするにはSDKが有効になっている必要があります。

注

Android 12を搭載したデバイスでは、カスタムプッシュ通知スタイルの変更により、レンダリングが異なります。

インライン画像プッシュを送信する

Androidプッシュメッセージを作成する際、この機能は通知タイプドロップダウンで利用できます。

設定

Brazeダッシュボードから送信されるAndroidプッシュ通知には、多くの高度な設定があります。この記事では、これらの機能と正しい使い方について説明します。

通知ID

通知IDは、選択したメッセージカテゴリの一意の識別子で、メッセージングサービスにそのIDからの最新のメッセージのみを尊重するよう指示します。通知IDを設定すると、古くなった無関係なメッセージの山ではなく、最新で関連性の高いメッセージのみを送信できます。

重複する通知による上書きを防止する

デフォルトでは、プッシュ通知のタイトルと本文が同一の場合、Androidはタイトルと本文の文字列をハッシュ化して同じ通知IDを生成します。これにより、2番目の通知が最初の通知を上書きし、通知トレイには1つの通知しか表示されなくなります。

同一の通知が互いに上書きされるのを防ぐには、Androidプッシュ通知設定で一意の通知ID値を指定できます。いくつかのオプションがあります。

• タイムスタンプを使用したLiquidテンプレート: 現在の時刻に基づいて一意の値を生成します。

1
2

{% assign random_number = 'now' | date: '%s' | plus: 1000000 %}
{{random_number}}

• サーバーサイド生成: 真にランダムな値を得るには、サーバーで通知IDを生成し、Liquidを通じて渡します。これにより各通知に固有の識別子が付与され、複数の通知を同時に表示できます。

Firebase Messagingの配信優先度

Firebase Messagingの配信優先度フィールドでは、プッシュをFirebase Cloud Messagingに「通常」または「高」優先度で送信するかどうかを制御できます。

有効期限（TTL）

有効期限（TTL）フィールドでは、プッシュメッセージングサービスにメッセージを保存するカスタムの期間を設定できます。デフォルト値はFCMが4週間、ADMが31日間です。

サマリーテキスト

サマリーテキストを使用すると、展開された通知ビューに追加テキストを設定できます。画像付き通知のキャプションとしても機能します。

サマリーテキストは、展開ビューでメッセージ本文の下に表示されます。

画像を含むプッシュ通知では、折りたたみビューにメッセージテキストが表示され、通知を展開するとサマリーテキストが画像キャプションとして表示されます。

カスタムURI

カスタムURI機能を使用すると、通知がクリックされたときに移動するWeb URLまたはAndroidリソースを指定できます。カスタムURIが指定されていない場合、通知をクリックするとユーザーはアプリに移動します。カスタムURIを使用してアプリ内のディープリンクを設定したり、アプリ外のリソースにユーザーを誘導したりできます。これはメッセージングAPIまたはダッシュボードのプッシュコンポーザーの高度な設定から指定できます（下図参照）。

通知表示の優先度

重要

通知表示の優先度設定は、Android O以降を実行しているデバイスでは使用されなくなりました。新しいデバイスでは、通知チャネルの設定を通じて優先度を設定してください。

プッシュ通知の優先度レベルは、通知トレイ内で他の通知と比較して通知がどのように表示されるかに影響します。また、配信の速度と方法にも影響を与える場合があります。通常および低優先度のメッセージはバッテリー寿命を維持するためにやや高いレイテンシで送信されたりバッチ処理されたりすることがありますが、高優先度のメッセージは常に即座に送信されます。

Android Oでは、通知の優先度は通知チャネルのプロパティになりました。開発者と協力してチャネルの設定時に優先度を定義し、通知サウンドを送信する際にダッシュボードで適切なチャネルを選択する必要があります。Android O以前のバージョンを実行しているデバイスでは、BrazeダッシュボードおよびメッセージングAPIを通じてAndroid通知の優先度レベルを指定できます。

特定の優先度でユーザー群全体にメッセージを送信するには、通知チャネルの設定を通じて間接的に優先度を指定し（O以降のデバイス向け）、かつダッシュボードから個別の優先度を送信する（<Oのデバイス向け）ことをお勧めします。

AndroidまたはFire OSプッシュ通知に設定できる優先度レベルは次のとおりです。

詳細については、GoogleのAndroid通知ドキュメントを参照してください。

サウンド

Android Oでは、通知サウンドは通知チャネルのプロパティになりました。開発者と協力してチャネルの設定時にサウンドを定義し、通知を送信する際にダッシュボードで適切なチャネルを選択する必要があります。

Android O以前のバージョンを実行しているデバイスでは、Brazeではダッシュボードコンポーザーを通じて個別のプッシュメッセージのサウンドを設定できます。デバイス上のローカルサウンドリソースを指定することで設定できます（例：android.resource://com.mycompany.myapp/raw/mysound）。このフィールドに「default」を指定すると、デバイスのデフォルト通知サウンドが再生されます。これはメッセージングAPIまたはダッシュボードのプッシュコンポーザーの高度な設定から指定できます。

完全なサウンドリソースURI（例：android.resource://com.mycompany.myapp/raw/mysound）をダッシュボードのプロンプトに入力してください。

特定のサウンドでユーザー群全体にメッセージを送信するには、通知チャネルの設定を通じて間接的にサウンドを指定し（O以降のデバイス向け）、かつダッシュボードから個別のサウンドを送信する（<Oのデバイス向け）ことをお勧めします。