プッシュ通知

前提条件

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

組み込み機能

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

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

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

• 権限の付与
• プッシュトークンの生成
• 通知の表示

---
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

プッシュ通知の設定

ヒント

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

レート制限

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

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

まず、AndroidプロジェクトにFirebaseを追加します。手順については、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:サービスアカウントを作成する

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

サービスアカウント名、ID、説明を入力し、Create and continueを選択します。

Roleフィールドで、ロール一覧からFirebase Cloud Messaging API Adminを探して選択します。より制限されたアクセスにするには、cloudmessaging.messages.create権限を持つカスタムロールを作成し、代わりにそのロールを一覧から選択します。完了したら、Doneを選択します。

警告

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

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

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

Add Key > Create new keyを選択します。

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

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

警告

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

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

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

AndroidアプリのPush Notification Settingsで、Firebaseを選択し、Upload JSON Fileを選択して先ほど生成した認証情報をアップロードします。完了したら、Saveを選択します。

警告

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

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

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

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

Cloud Messagingを選択し、Firebase Cloud Messaging API (V1)の下にあるSender IDフィールドの番号をコピーします。

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

• braze.xml
• brazeconfig

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>

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>

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

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

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インスタンスのregisteredPushTokenプロパティを設定します。

1
2
// Kotlin
Braze.getInstance(context).registeredPushToken = "FCM_TOKEN"

1
2
// Java
Braze.getInstance(context).setRegisteredPushToken("FCM_TOKEN");

複数のFirebaseプロジェクトを使用する

アプリが複数のFirebaseプロジェクトを使用している場合は、以下の手順に従います：

1. Brazeプッシュは、アプリのgoogle-services.jsonから初期化されるデフォルトのFirebaseプロジェクトで使用します。
2. カスタムのFirebaseメッセージングサービスを使用する場合は、カスタムFirebaseメッセージングサービスでインストールIDを登録するを完了してください。
3. アプリが別の方法でプッシュトークンを取得する場合は、前述のヒントに示すように手動でregisteredPushTokenを設定します。

重要

Firebase Cloud Messagingには、手動で初期化したFirebaseAppからトークンを取得するサポートされたAPIはありません。onNewTokenやonRegisteredなどのFirebaseMessagingServiceコールバックは、デフォルトのプロジェクトに対してのみ発火します。詳細については、Firebaseドキュメントの複数プロジェクトの設定を参照してください。

バージョンの詳細については、SDK変更ログを参照してください。

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

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

通知の表示

ステップ1:Braze Firebase Messaging Serviceを登録する

新規、既存、またはBraze以外のFirebase Messaging Serviceを作成できます。特定のニーズに最適なものを選択してください。

• 新規
• 既存
• 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が登録されている場合、BrazeFirebaseMessagingService.handleBrazeRemoteMessage()を介してRemoteMessageオブジェクトをBrazeに渡すことができます。このメソッドは、RemoteMessageオブジェクトがBrazeから発信された場合にのみ通知を表示し、そうでない場合は安全に無視します。

カスタムFirebase Messaging ServiceでインストールIDを登録する

firebase-messaging v25.1.0以降を使用している場合、Firebase登録にはFirebase Installation IDが使用されます。カスタムFirebase Messaging ServiceでonRegisteredをオーバーライドし、registeredPushTokenを設定します。

• java
• kotlin

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
public class MyFirebaseMessagingService extends FirebaseMessagingService {
  @Override
  public void onRegistered(String installationId) {
    super.onRegistered(installationId);
    Braze.getInstance(this).setRegisteredPushToken(installationId);
  }

  @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
13
14
15
16
17
class MyFirebaseMessagingService : FirebaseMessagingService() {
  override fun onRegistered(installationId: String) {
    super.onRegistered(installationId)
    Braze.getInstance(this).registeredPushToken = installationId
  }

  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.
    }
  }
}

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は通知の小さいアイコンの透過領域を除くすべての部分をモノクロに変換します。

通知の小さいアイコンアセットを適切に作成するには：

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

注

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

以下の大きいアイコンと小さいアイコンは、適切にデザインされたアイコンの例です。

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

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

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

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はペイロードが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ダッシュボードでは、プッシュ通知キャンペーンやキャンバスにディープリンクまたは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プッシュオブジェクトパラメーターにnotification_channelフィールドを含めるように、すべてのAPIキャンペーンを更新してください。このフィールドが指定されていない場合、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ダッシュボードのキャンペーンページに移動し、プッシュ通知キャンペーンを作成します。Androidプッシュを選択し、メッセージをデザインします。次に、コンポーザーの目のアイコンをクリックしてテスト送信画面を開きます。現在のユーザーのユーザーIDまたはメールアドレスを入力し、テスト送信をクリックします。デバイスにプッシュ通知が表示されるはずです。

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

分析のテスト

この時点で、プッシュ通知開封の分析ログも取得できるはずです。通知が届いたときにクリックすると、キャンペーン結果ページの直接開封が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 Console > APIs & Services > Firebase Cloud Messaging API > Quotas & System Limits にアクセスするか、FCM APIクォータページにアクセスしてください。

ベストプラクティス

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

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

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

1. FCM APIクォータページにアクセスします。
2. Send requests per minute クォータを探します。
3. Edit Quota を選択します。
4. 新しい値を入力してリクエストを送信します。

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

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