プッシュ通知

前提条件

この機能を使用する前に、Android Braze SDKを統合する必要がある。

内蔵機能

以下の機能はBraze Android SDKに組み込まれています。その他のプッシュ通知機能を利用するには、アプリ向けにプッシュ通知を設定する必要があります。

プッシュ通知のライフサイクルについて

以下のフローチャートは、Brazeがプッシュ通知のライフサイクル（許可プロンプト、トークン生成、メッセージ配信など）をどのように処理するかを示しています。

• granting permissions
• generating push tokens
• displaying notifications

---
config:
  theme: neutral
---
flowchart TD

%% Permission flow
subgraph Permission[Push Permissions]
    B{Android version of the device?}
    B -->|Android 13+| C["requestPushPermissionPrompt() called"]
    B -->|Android 12 and earlier| D[No permissions required]

    %% Connect Android 12 path to Braze state
    D --> H3[Braze: user subscription state]
    H3 --> J3[Defaults to 'subscribed' when user profile created]

    C --> E{Did the user grant push permission?}
    E -->|Yes| F[POST_NOTIFICATIONS permission granted]
    E -->|No| G[POST_NOTIFICATIONS permission denied]

    %% Braze subscription state updates
    F --> H1[Braze: user subscription state]
    G --> H2[Braze: user subscription state]

    H1 --> I1{Automatically opt in after permission granted?}
    I1 -->|true| J1[Set to 'opted-in']
    I1 -->|false| J2[Remains 'subscribed']

    H2 --> K1[Remains 'subscribed'<br/>or 'unsubscribed']

    %% Subscription state legend
    subgraph BrazeStates[Braze subscription states]
        L1['Subscribed' - default state<br/>when user profile created]
        L2['Opted-in' - user explicitly<br/>wants push notifications]
        L3['Unsubscribed' - user explicitly<br/>opted out of push]
    end

    %% Note about user-level states
    note1[Note: These states are user-level<br/>and apply across all devices for the user]

    %% Connect states to legend
    J1 -.-> L2
    J2 -.-> L1
    J3 -.-> L1
    K1 -.-> L3
    note1 -.-> BrazeStates
end

%% Styling
classDef permissionClass fill:#e3f2fd,stroke:#1565c0,stroke-width:2px
classDef tokenClass fill:#e8f5e9,stroke:#2e7d32,stroke-width:2px
classDef sdkClass fill:#fff3e0,stroke:#e65100,stroke-width:2px
classDef configClass fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px
classDef displayClass fill:#ffebee,stroke:#c62828,stroke-width:2px
classDef deliveryClass fill:#fce4ec,stroke:#c2185b,stroke-width:2px
classDef brazeClass fill:#e8f5e9,stroke:#2e7d32,stroke-width:3px

class A,B,C,E,F,G permissionClass
class H,I tokenClass
class J,K sdkClass
class N,O,P configClass
class R,S,S1,T,U,V displayClass
class W,X,X1,X2,Y,Z deliveryClass
class H1,H2,H3,I1,J1,J2,J3,K1,L1,L2,L3,note1 brazeClass

---
config:
  theme: neutral
---
flowchart TD

%% Token generation flow
subgraph Token[Token Generation]
    H["Braze SDK initialized"] --> Q{Is FCM auto-registration enabled?}
    Q -->|Yes| L{Is required configuration present?}
    Q -->|No| M[No FCM token generated]
    L -->|Yes| I[Generate FCM token]
    L -->|No| M
    I --> K[Register token with Braze]

    %% Configuration requirements
    subgraph Config[Required configuration]
        N['google-services.json' file is present]
        O['com.google.firebase:firebase-messaging' in gradle]
        P['com.google.gms.google-services' plugin in gradle]
    end

    %% Connect config to check
    N -.-> L
    O -.-> L
    P -.-> L
end

%% Styling
classDef permissionClass fill:#e3f2fd,stroke:#1565c0,stroke-width:2px
classDef tokenClass fill:#e8f5e9,stroke:#2e7d32,stroke-width:2px
classDef sdkClass fill:#fff3e0,stroke:#e65100,stroke-width:2px
classDef configClass fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px
classDef displayClass fill:#ffebee,stroke:#c62828,stroke-width:2px
classDef deliveryClass fill:#fce4ec,stroke:#c2185b,stroke-width:2px
classDef brazeClass fill:#e8f5e9,stroke:#2e7d32,stroke-width:3px

class A,B,C,E,F,G permissionClass
class H,I tokenClass
class J,K sdkClass
class N,O,P configClass
class R,S,S1,T,U,V displayClass
class W,X,X1,X2,Y,Z deliveryClass
class H1,H2,H3,I1,J1,J2,J3,K1,L1,L2,L3,note1 brazeClass

---
config:
  theme: neutral
  fontSize: 10
---
flowchart TD

subgraph Display[Push Display]
    %% Push delivery flow
    W[Push sent to FCM servers] --> X{Did FCM receive push?}
    X -->|App is terminated| Y[FCM cannot deliver push to the app]
    X -->|Delivery conditions met| X1[App receives push from FCM]
    X1 --> X2[Braze SDK receives push]
    X2 --> R[Push type?]

    %% Push Display Flow
    R -->|Standard push| S{Is push permission required?}
    R -->|Silent push| T[Braze SDK processes silent push]
    S -->|Yes| S1{Did the user grant push permission?}
    S -->|No| V[Notification is shown to the user]
    S1 -->|Yes| V
    S1 -->|No| U[Notification is not shown to the user]
end

%% Styling
classDef permissionClass fill:#e3f2fd,stroke:#1565c0,stroke-width:2px
classDef tokenClass fill:#e8f5e9,stroke:#2e7d32,stroke-width:2px
classDef sdkClass fill:#fff3e0,stroke:#e65100,stroke-width:2px
classDef configClass fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px
classDef displayClass fill:#ffebee,stroke:#c62828,stroke-width:2px
classDef deliveryClass fill:#fce4ec,stroke:#c2185b,stroke-width:2px
classDef brazeClass fill:#e8f5e9,stroke:#2e7d32,stroke-width:3px

class A,B,C,E,F,G permissionClass
class H,I tokenClass
class J,K sdkClass
class N,O,P configClass
class R,S,S1,T,U,V displayClass
class W,X,X1,X2,Y,Z deliveryClass
class H1,H2,H3,I1,J1,J2,J3,K1,L1,L2,L3,note1 brazeClass

プッシュ通知の設定

ヒント

Braze Android SDKでFCMを使用するサンプルアプリを確認するには、Braze: Firebase Push サンプルアプリを参照してください。

レート制限

Firebase Cloud Messaging（FCM）APIには、1分あたり600,000リクエストというデフォルトのレート制限があります。この制限に達した場合、Brazeは数分後に自動的に再試行します。引き上げをリクエストするには、Firebaseサポートにお問い合わせください。

ステップ1: Firebaseをプロジェクトに追加する

まず、FirebaseをAndroidプロジェクトに追加します。手順については、GoogleのFirebaseセットアップガイドを参照してください。

ステップ2: Cloud Messagingを依存関係に追加する

次に、Cloud Messagingライブラリーをプロジェクトの依存関係に追加します。Androidプロジェクトでbuild.gradleを開き、dependenciesブロックに次の行を追加します。

1
implementation "google.firebase:firebase-messaging:+"

依存関係は次のようになります。

1
2
3
4
dependencies {
  implementation project(':android-sdk-ui')
  implementation "com.google.firebase:firebase-messaging:+"
}

ステップ3: Firebase Cloud Messaging APIを有効にする

Google Cloudで、Androidアプリが使用しているプロジェクトを選択し、Firebase Cloud Messaging APIを有効にします。

ステップ4: サービスアカウントを作成する

次に、新しいサービスアカウントを作成し、FCMトークンの登録時にBrazeが許可されたAPI呼び出しを行えるようにします。Google Cloudでサービスアカウントに移動し、プロジェクトを選択します。サービスアカウントページでサービスアカウントの作成を選択します。

サービスアカウント名、ID、説明を入力して、作成して続行を選択します。

ロールフィールドで、ロールのリストからFirebase Cloud Messaging API管理者を見つけて選択します。アクセスをより制限する場合は、cloudmessaging.messages.create権限を持つカスタムロールを作成し、代わりにリストからそれを選択します。完了したら、完了を選択します。

警告

Firebase Cloud Messaging管理者ではなく、Firebase Cloud Messaging API 管理者を選択してください。

ステップ5: JSON認証情報を生成する

次に、FCMサービスアカウントのJSON認証情報を生成します。Google Cloud IAM & Adminでサービスアカウントに移動し、プロジェクトを選択します。先ほど作成したFCMサービスアカウントを見つけて、 アクション > キーの管理を選択します。

キーの追加 > 新しいキーを作成を選択します。

JSONを選択し、作成を選択します。FCMプロジェクトIDとは異なるGoogle CloudプロジェクトIDを使用してサービスアカウントを作成した場合は、JSONファイルでproject_idに割り当てられた値を手動で更新する必要があります。

キーをどこにダウンロードしたかを覚えておいてください—次のステップで必要になります。

警告

秘密キーが漏洩した場合は、セキュリティリスクが生じる可能性があります。JSON認証情報は安全な場所に保存しておいてください—キーはBrazeにアップロードした後で削除します。

ステップ6: JSON認証情報をBrazeにアップロードする

次に、JSON認証情報をBrazeダッシュボードにアップロードします。Brazeで、 設定 > アプリ設定を選択します。

Androidアプリのプッシュ通知の設定でFirebaseを選択し、JSONファイルのアップロードを選択して、先ほど生成した認証情報をアップロードします。完了したら、保存を選択します。

警告

秘密キーが漏洩した場合は、セキュリティリスクが生じる可能性があります。キーがBrazeにアップロードされたので、先に生成したファイルを削除してください。

ステップ7: トークンの自動登録を設定する

ユーザーがプッシュ通知をオプトインした場合、アプリはそのユーザーにプッシュ通知を送信する前に、ユーザーのデバイス上でFCMトークンを生成する必要があります。Braze SDKを使用すると、プロジェクトのBraze設定ファイルで各ユーザーのデバイスのFCMトークン自動登録を有効にできます。

まずFirebase Consoleに移動し、プロジェクトを開いて、 設定 > プロジェクト設定を選択します。

Cloud Messagingを選択し、Firebase Cloud Messaging API (V1)で送信者IDフィールドの数字をコピーします。

次に、Android Studioプロジェクトを開き、Firebase送信者IDを使用して、braze.xmlまたはBrazeConfig内でFCMトークンの自動登録を有効にします。

• braze.xml
• brazeconfig

FCMトークンの自動登録を設定するには、braze.xmlファイルに以下の行を追加します。

1
2
<bool translatable="false" name="com_braze_firebase_cloud_messaging_registration_enabled">true</bool>
<string translatable="false" name="com_braze_firebase_cloud_messaging_sender_id">FIREBASE_SENDER_ID</string>

FIREBASE_SENDER_IDをFirebaseプロジェクトの設定からコピーした値に置き換えます。braze.xmlは次のようになります。

1
2
3
4
5
6
<?xml version="1.0" encoding="utf-8"?>
<resources>
  <string translatable="false" name="com_braze_api_key">12345ABC-6789-DEFG-0123-HIJK456789LM</string>
  <bool translatable="false" name="com_braze_firebase_cloud_messaging_registration_enabled">true</bool>
<string translatable="false" name="com_braze_firebase_cloud_messaging_sender_id">603679405392</string>
</resources>

FCMトークンの自動登録を設定するには、BrazeConfigに以下の行を追加します。

• java
• kotlin

1
2
.setIsFirebaseCloudMessagingRegistrationEnabled(true)
.setFirebaseCloudMessagingSenderIdKey("FIREBASE_SENDER_ID")

1
2
.setIsFirebaseCloudMessagingRegistrationEnabled(true)
.setFirebaseCloudMessagingSenderIdKey("FIREBASE_SENDER_ID")

FIREBASE_SENDER_IDをFirebaseプロジェクトの設定からコピーした値に置き換えます。BrazeConfigは次のようになります。

• java
• kotlin

1
2
3
4
5
6
7
8
9
10
BrazeConfig brazeConfig = new BrazeConfig.Builder()
  .setApiKey("12345ABC-6789-DEFG-0123-HIJK456789LM")
  .setCustomEndpoint("sdk.iad-01.braze.com")
  .setSessionTimeout(60)
  .setHandlePushDeepLinksAutomatically(true)
  .setGreatNetworkDataFlushInterval(10)
  .setIsFirebaseCloudMessagingRegistrationEnabled(true)
  .setFirebaseCloudMessagingSenderIdKey("603679405392")
  .build();
Braze.configure(this, brazeConfig);

1
2
3
4
5
6
7
8
9
10
val brazeConfig = BrazeConfig.Builder()
  .setApiKey("12345ABC-6789-DEFG-0123-HIJK456789LM")
  .setCustomEndpoint("sdk.iad-01.braze.com")
  .setSessionTimeout(60)
  .setHandlePushDeepLinksAutomatically(true)
  .setGreatNetworkDataFlushInterval(10)
  .setIsFirebaseCloudMessagingRegistrationEnabled(true)
  .setFirebaseCloudMessagingSenderIdKey("603679405392")
  .build()
Braze.configure(this, brazeConfig)

ヒント

代わりにFCMトークンを手動で登録する場合は、アプリのonCreate()メソッド内でBraze.setRegisteredPushToken()を呼び出すことができます。

ステップ8: アプリケーションクラスの自動リクエストを削除する

サイレントプッシュ通知を送信するたびにBrazeが不要なネットワークリクエストをトリガーするのを防ぐには、ApplicationクラスのonCreate()メソッドで設定されている自動ネットワークリクエストをすべて削除してください。詳細については、Android開発者リファレンス: Applicationを参照してください。

通知を表示する

ステップ1: Braze Firebaseメッセージングサービスを登録する

新規、既存、またはBraze以外のFirebaseメッセージングサービスを作成できます。特定のニーズに最も合うものを選択してください。

• 新規
• 既存
• braze以外

Brazeには、プッシュ受信インテントと開封インテントを処理するサービスが含まれています。BrazeFirebaseMessagingServiceクラスはAndroidManifest.xmlに登録する必要があります。

1
2
3
4
5
6
<service android:name="com.braze.push.BrazeFirebaseMessagingService"
  android:exported="false">
  <intent-filter>
    <action android:name="com.google.firebase.MESSAGING_EVENT" />
  </intent-filter>
</service>

通知コードでは、BrazeFirebaseMessagingServiceを使用して、オープンアクションとクリックアクションのトラッキングも処理します。このサービスが正しく機能するには、AndroidManifest.xmlに登録する必要があります。また、Brazeはシステムからの通知に固有のキーをプレフィックスとして付加するため、Brazeのシステムから送信された通知のみをレンダリングします。他のFCMサービスから送信される通知を表示するために、追加のサービスを個別に登録することもできます。FirebaseプッシュサンプルアプリのAndroidManifest.xmlを参照してください。

重要

Braze SDK 3.1.1より前では、FCMプッシュを処理するためにAppboyFcmReceiverが使用されていました。マニフェストからAppboyFcmReceiverクラスを削除し、前述の統合に置き換える必要があります。

Firebase Messaging Serviceがすでに登録されている場合は、RemoteMessageオブジェクトをBrazeFirebaseMessagingService.handleBrazeRemoteMessage()経由でBrazeに渡すことができます。このメソッドはRemoteMessageオブジェクトがBrazeから発信された場合にのみ通知を表示し、そうでない場合は安全に無視します。

• java
• kotlin

1
2
3
4
5
6
7
8
9
10
11
12
13
public class MyFirebaseMessagingService extends FirebaseMessagingService {
  @Override
  public void onMessageReceived(RemoteMessage remoteMessage) {
    super.onMessageReceived(remoteMessage);
    if (BrazeFirebaseMessagingService.handleBrazeRemoteMessage(this, remoteMessage)) {
      // This Remote Message originated from Braze and a push notification was displayed.
      // No further action is needed.
    } else {
      // This Remote Message did not originate from Braze.
      // No action was taken and you can safely pass this Remote Message to other handlers.
    }
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
class MyFirebaseMessagingService : FirebaseMessagingService() {
  override fun onMessageReceived(remoteMessage: RemoteMessage?) {
    super.onMessageReceived(remoteMessage)
    if (BrazeFirebaseMessagingService.handleBrazeRemoteMessage(this, remoteMessage)) {
      // This Remote Message originated from Braze and a push notification was displayed.
      // No further action is needed.
    } else {
      // This Remote Message did not originate from Braze.
      // No action was taken and you can safely pass this Remote Message to other handlers.
    }
  }
}

使用したい別のFirebase Messaging Serviceがある場合は、アプリケーションがBrazeからではないプッシュを受信した場合に呼び出すフォールバックFirebase Messaging Serviceを指定することもできます。

braze.xmlで次のように指定します。

1
2
<bool name="com_braze_fallback_firebase_cloud_messaging_service_enabled">true</bool>
<string name="com_braze_fallback_firebase_cloud_messaging_service_classpath">com.company.OurFirebaseMessagingService</string>

または、ランタイム設定で設定します。

• java
• kotlin

1
2
3
4
5
BrazeConfig brazeConfig = new BrazeConfig.Builder()
        .setFallbackFirebaseMessagingServiceEnabled(true)
        .setFallbackFirebaseMessagingServiceClasspath("com.company.OurFirebaseMessagingService")
        .build();
Braze.configure(this, brazeConfig);

1
2
3
4
5
val brazeConfig = BrazeConfig.Builder()
        .setFallbackFirebaseMessagingServiceEnabled(true)
        .setFallbackFirebaseMessagingServiceClasspath("com.company.OurFirebaseMessagingService")
        .build()
Braze.configure(this, brazeConfig)

ステップ2: 小さなアイコンをデザインガイドラインに準拠させる

Android通知アイコンの一般的な情報については、通知の概要をご覧ください。

Android N以降、色を使った小さな通知アイコンアセットは更新または削除する必要があります。Androidシステム（Braze SDKではない）は、アクションアイコンと小さな通知アイコンの非アルファチャネルと透明チャネルをすべて無視します。つまり、Androidは小さな通知アイコンの透明領域を除くすべての部分をモノクロに変換します。

正しく表示される通知用小さなアイコンアセットを作成するには：

• 画像から白以外のすべての色を削除します。
• アセットの他のすべての非白色領域は透明にする必要があります。

注

不適切なアセットでよく見られる症状の1つは、小さな通知アイコンが単色の正方形としてレンダリングされることです。これは、Androidシステムが小さな通知アイコンアセットで透明領域を見つけられないことが原因です。

次の図の大小アイコンは、適切にデザインされたアイコンの例です。

ステップ3: 通知アイコンを設定する

braze.xmlでアイコンを指定する

Brazeでは、braze.xml内でdrawableリソースを指定することで、通知アイコンを設定できます。

1
2
<drawable name="com_braze_push_small_notification_icon">REPLACE_WITH_YOUR_ICON</drawable>
<drawable name="com_braze_push_large_notification_icon">REPLACE_WITH_YOUR_ICON</drawable>

小さな通知アイコンの設定は必須です。設定しない場合、Brazeはデフォルトでアプリケーションアイコンを小さな通知アイコンとして使用しますが、最適に表示されない可能性があります。

大きな通知アイコンの設定は任意ですが、推奨されます。

アイコンのアクセントカラーを指定する

通知アイコンのアクセントカラーは、braze.xmlでオーバーライドできます。色を指定しない場合、デフォルトの色はLollipopがシステム通知に使用するのと同じグレーになります。

1
<integer name="com_braze_default_notification_accent_color">0xFFf33e3e</integer>

オプションでカラーリファレンスを使用することもできます。

1
<color name="com_braze_default_notification_accent_color">@color/my_color_here</color>

ステップ4: ディープリンクを追加する

ディープリンクの自動オープンを有効にする

プッシュ通知がクリックされたときにBrazeがアプリとディープリンクを自動的に開くようにするには、braze.xmlでcom_braze_handle_push_deep_links_automaticallyをtrueに設定します。

1
<bool name="com_braze_handle_push_deep_links_automatically">true</bool>

このフラグは、ランタイム設定で設定することもできます。

• java
• kotlin

1
2
3
4
BrazeConfig brazeConfig = new BrazeConfig.Builder()
        .setHandlePushDeepLinksAutomatically(true)
        .build();
Braze.configure(this, brazeConfig);

1
2
3
4
val brazeConfig = BrazeConfig.Builder()
        .setHandlePushDeepLinksAutomatically(true)
        .build()
Braze.configure(this, brazeConfig)

ディープリンクをカスタムで処理する場合は、Brazeからのプッシュ受信およびオープンインテントをリッスンするプッシュコールバックを作成する必要があります。詳細については、プッシュイベントのコールバックの使用を参照してください。

フォアグラウンド通知の処理

Androidでは、アプリがフォアグラウンドにあるときにプッシュ通知が届くと、デフォルトでシステムが自動的に表示します。Brazeにプッシュ通知のペイロードを処理させる場合（分析トラッキング、ディープリンク処理、カスタム処理のため）、FirebaseMessagingService.onMessageReceivedメソッド内で受信したプッシュデータをBrazeにルーティングしてください。

仕組み

BrazeFirebaseMessagingService.handleBrazeRemoteMessageを呼び出すと、Brazeはペイロードがプッシュ通知かどうかを判断し、該当する場合はNotificationManagerCompatメソッドで通知を作成して表示します。iOSとは異なり、Androidはアプリがフォアグラウンドにあるかバックグラウンドにあるかを問わず通知を表示します。

• java
• kotlin

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
package com.example.push;

import com.braze.push.BrazeFirebaseMessagingService;
import com.google.firebase.messaging.FirebaseMessagingService;
import com.google.firebase.messaging.RemoteMessage;

public class MyFirebaseMessagingService extends FirebaseMessagingService {
    @Override
    public void onMessageReceived(RemoteMessage remoteMessage) {
        super.onMessageReceived(remoteMessage);

        // Let Braze process the payload and display the notification
        if (BrazeFirebaseMessagingService.handleBrazeRemoteMessage(this, remoteMessage)) {
            // Braze successfully handled the push notification
        } else {
            // Handle non-Braze messages
        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
package com.example.push

import com.braze.push.BrazeFirebaseMessagingService
import com.google.firebase.messaging.FirebaseMessagingService
import com.google.firebase.messaging.RemoteMessage

class MyFirebaseMessagingService : FirebaseMessagingService() {
    override fun onMessageReceived(remoteMessage: RemoteMessage) {
        super.onMessageReceived(remoteMessage)

        // Let Braze process the payload and display the notification
        if (BrazeFirebaseMessagingService.handleBrazeRemoteMessage(this, remoteMessage)) {
            // Braze successfully handled the push notification
        } else {
            // Handle non-Braze messages
        }
    }
}

詳細については、Braze Android SDKリポジトリ内のFirebase統合サンプルを参照してください。

フォアグラウンド動作のカスタマイズ

カスタムのフォアグラウンド動作を実装したい場合（システム通知を抑制したり、代わりにアプリ内UIを表示したりするなど）、以下の方法があります。

• subscribeToPushNotificationEventsを使用してプッシュイベントに反応し、BrazeNotificationUtils.routeUserWithNotificationOpenedIntentメソッドでディープリンクを処理します。詳細については、Firebaseプッシュサンプルを参照してください。
• カスタムのIBrazeNotificationFactoryを使用して独自の通知を構築して投稿するか、処理パスでnotificationManager.notifyを呼び出さないことで通知を抑制します。

通知のカスタマイズに関する詳細は、カスタム通知ファクトリを参照してください。

カスタムディープリンクの作成

アプリにまだディープリンクを追加していない場合は、Android開発者ドキュメントに記載されているディープリンクに関する手順に従ってください。ディープリンクの詳細については、FAQの記事を参照してください。

ディープリンクの追加

Brazeダッシュボードではプッシュ通知のCampaignやCanvasesで、通知がクリックされたときに開くディープリンクまたはWeb URLを設定できます。

バックスタック動作のカスタマイズ

Android SDKのデフォルトでは、プッシュのディープリンクを辿ると、ホストアプリのメインのランチャーアクティビティがバックスタックに配置されます。Brazeでは、メインのランチャーアクティビティの代わりにバックスタックで開くカスタムアクティビティを設定したり、バックスタックを完全に無効にしたりすることができます。

たとえば、ランタイム設定を使用して、YourMainActivityというアクティビティをバックスタックアクティビティとして設定するには、次のようにします。

• java
• kotlin

1
2
3
4
5
BrazeConfig brazeConfig = new BrazeConfig.Builder()
        .setPushDeepLinkBackStackActivityEnabled(true)
        .setPushDeepLinkBackStackActivityClass(YourMainActivity.class)
        .build();
Braze.configure(this, brazeConfig);

1
2
3
4
5
val brazeConfig = BrazeConfig.Builder()
        .setPushDeepLinkBackStackActivityEnabled(true)
        .setPushDeepLinkBackStackActivityClass(YourMainActivity.class)
        .build()
Braze.configure(this, brazeConfig)

braze.xmlの同等の設定を参照してください。クラス名はClass.forName()で返されるものと同じでなければならないことに注意してください。

1
2
<bool name="com_braze_push_deep_link_back_stack_activity_enabled">true</bool>
<string name="com_braze_push_deep_link_back_stack_activity_class_name">your.package.name.YourMainActivity</string>

ステップ5: 通知チャネルを定義する

Braze Android SDKはAndroid通知チャネルをサポートしています。Brazeの通知に通知チャネルのIDが含まれていない場合、またはBrazeの通知に無効なチャネルIDが含まれている場合、BrazeはSDKで定義されているデフォルトの通知チャネルで通知を表示します。会社ユーザーはプラットフォーム内でAndroid通知チャネルを使用して通知をグループ化します。

デフォルトのBraze通知チャネルのユーザー向けの名前を設定するには、BrazeConfig.setDefaultNotificationChannelName()を使用します。

デフォルトのBraze通知チャネルのユーザー向けの説明を設定するには、BrazeConfig.setDefaultNotificationChannelDescription()を使用します。

Androidプッシュオブジェクトパラメータを使用してAPIキャンペーンを更新し、notification_channelフィールドを含めます。このフィールドが指定されていない場合、BrazeはダッシュボードフォールバックチャネルIDを持つ通知ペイロードを送信します。

デフォルトの通知チャネル以外、Brazeはチャネルを作成しません。他のすべてのチャネルは、ホストアプリでプログラムで定義してから、Brazeダッシュボードに入力する必要があります。

デフォルトのチャネル名と説明もbraze.xmlで設定できます。

1
2
<string name="com_braze_default_notification_channel_name">Your channel name</string>
<string name="com_braze_default_notification_channel_description">Your channel description</string>

ステップ6: 通知の表示と分析をテストする

表示のテスト

この時点で、Brazeから送信された通知を表示できるはずです。これをテストするには、BrazeダッシュボードのCampaignsページにアクセスし、プッシュ通知Campaignを作成します。Android Pushを選択し、メッセージをデザインします。次に、作成画面で目のアイコンをクリックしてテスト送信者を取得します。現在のユーザーのユーザーIDまたはメールアドレスを入力し、Send Testをクリックします。デバイスにプッシュが表示されます。

プッシュ表示に関する問題については、トラブルシューティングガイドを参照してください。

分析のテスト

この時点で、プッシュ通知の開封に関する分析ログも記録されているはずです。届いた通知をクリックすると、Campaign結果ページの直接開封数の値が1増えます。プッシュ分析の内訳については、プッシュレポートの記事をご覧ください。

プッシュ分析に関する問題については、トラブルシューティングガイドを参照してください。

コマンドラインからのテスト

コマンドラインインターフェイスを介してアプリ内通知とプッシュ通知をテストする場合は、cURLとメッセージングAPIを介してターミナルから単一の通知を送信できます。次のフィールドをテストケースの正しい値に置き換える必要があります。

• YOUR_API_KEY（設定 > APIキーに移動）
• YOUR_EXTERNAL_USER_ID（ユーザーを検索ページでプロファイルを検索）
• YOUR_KEY1（省略可能）
• YOUR_VALUE1（省略可能）

1
2
3
4
5
6
7
8
9
10
11
12
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer {YOUR_API_KEY}" -d '{
  "external_user_ids":["YOUR_EXTERNAL_USER_ID"],
  "messages": {
    "android_push": {
      "title":"Test push title",
      "alert":"Test push",
      "extra": {
        "YOUR_KEY1":"YOUR_VALUE1"
      }
    }
  }
}' https://rest.iad-01.braze.com/messages/send

この例では、US-01インスタンスを使用しています。このインスタンスを使用していない場合は、US-01エンドポイントを自分のエンドポイントに置き換えてください。

会話プッシュ通知

人と会話のイニシアチブは、スマートフォンのシステムサーフェスで人との会話を向上させることを目的とした、複数年にわたるAndroidの取り組みです。この優先順位は、他のユーザーとのコミュニケーションや対話が、あらゆるユーザー層にわたる大多数のAndroidユーザーにとって、依然として最も価値のある重要な機能分野であるという事実に基づいています。

使用要件

• この通知タイプには、Braze Android SDK v15.0.0以降とAndroid 11以降のデバイスが必要です。
• サポートされていないデバイスやSDKは、標準のプッシュ通知にフォールバックします。

この機能はBraze REST API経由でのみ利用できます。詳細については、Androidプッシュオブジェクトを参照してください。

FCMのクォータ超過エラー

Firebase Cloud Messaging（FCM）の制限を超過すると、Googleは「クォータ超過」エラーを返します。FCMのデフォルトの制限は、1分あたり600,000リクエストです。BrazeはGoogleが推奨するベストプラクティスに従って送信を再試行します。しかし、こうしたエラーが大量に発生すると、送信時間が数分間長引くことがあります。潜在的な影響を軽減するために、Brazeはレート制限を超えていることを示すアラートと、エラーを防ぐために実行できるステップを送信します。

現在の制限を確認するには、Google Cloudコンソール > APIとサービス > Firebase Cloud Messaging API > クォータとシステム制限に移動するか、FCM APIクォータのページにアクセスしてください。

ベストプラクティス

これらのエラー発生量を低く抑えるために、以下のベストプラクティスを推奨します。

FCMにレート制限の引き上げをリクエストする

FCMのレート制限の引き上げをリクエストするには、Firebaseサポートに直接連絡するか、以下の手順を実行します。

1. FCM APIのクォータページに移動します。
2. 1分あたりのリクエスト送信クォータを確認します。
3. クォータの編集を選択します。
4. 新しい値を入力し、リクエストを送信します。

ワークスペースのレート制限を適用する

Androidプッシュ通知にワークスペースのレート制限を適用できます。これにより、送信メッセージの配信レートを調整できます。詳細については、ワークスペースのメッセージングレート制限を参照してください。