Android プッシュ通知の統合

このリファレンス記事では、Unityプラットフォーム用のAndroidプッシュ通知統合について説明する。

これらの手順は、Firebase Cloud Messaging (FCM) とプッシュを統合するためのものである。

ADM の統合手順については、Unity ADMのドキュメントを参照してください。

ステップ 1:Firebaseを有効にする

開始するには、Firebase Unity の設定ドキュメントに従ってください。

ステップ2:Firebaseの認証情報を設定する

Firebase サーバーキーと送信者 ID を Braze ダッシュボードに入力する必要があります。これを行うには、Firebase Developers Consoleにログインし、Firebase プロジェクトを選択します。次に、[設定] で「クラウドメッセージング」を選択し、サーバーキーと送信者 ID をコピーします。

Braze のアプリ設定ページの [設定の管理] で Android アプリを選択します。次に、[Firebase Cloud Messaging サーバーキー] フィールドに「Firebase サーバーキー」を入力し、「Firebase Cloud メッセージング送信者」ID フィールドに「Firebase 送信者 ID」を入力します。

ステップ 3: 自動プッシュ統合を導入する

Braze SDK は、Firebase Cloud メッセージングサーバーへのプッシュ登録を自動的に処理して、デバイスがプッシュ通知を受信できるようにすることができます。

• Firebase Cloud メッセージングの自動登録が有効に
  デバイスの FCM プッシュトークンを自動的に取得して送信するように Braze SDK に指示します。
• Firebase クラウドメッセージング送信者 ID
  Firebase コンソールの送信者 ID。
• プッシュディープリンクを自動的に処理する
  プッシュ通知がクリックされたときに、ディープリンクを開くかアプリを開くかを SDK で処理するかどうか。
• 描画可能な小さな通知アイコン
  Drawable は、プッシュ通知を受け取るたびに小さなアイコンとして表示されなければなりません。アイコンが提供されていない場合、通知はアプリケーションアイコンをスモールアイコンとして使用する。

ステップ 4:プッシュリスナーを設定する

プッシュ通知のペイロードをUnityに渡したり、ユーザーがプッシュ通知を受信したときに追加の処理を行いたい場合、Brazeはプッシュ通知リスナーを設定するオプションを提供する。

Braze のアプリ設定ページの [設定の管理] で Android アプリを選択します。次に、Firebase サーバーキーを [プッシュ通知設定] フィールドに、Firebase 送信者 ID を [プッシュ通知設定] ID フィールドに入力します。

プッシュ受信リスナー

プッシュ受信リスナーは、ユーザーがプッシュ通知を受信したときに起動される。Unity にプッシュペイロードを送信するには、ゲームオブジェクトの名前を設定し、[プッシュ受信リスナーの設定] の下にある受信リスナーのコールバックメソッドをプッシュします。

プッシュ開封済みリスナー

ユーザーがプッシュ通知をクリックしてアプリを起動すると、プッシュ開封済みリスナーが起動します。Unity にプッシュペイロードを送信するには、ゲームオブジェクトの名前を設定し、[プッシュ開封済みリスナーを設定する] の下にある開封済みリスナーのコールバックメソッドをプッシュします。

プッシュ削除リスナー (Android のみ)

プッシュ削除リスナーは、ユーザーがプッシュ通知をスワイプして削除したり、無視したときに起動されます。Unity にプッシュペイロードを送信するには、ゲームオブジェクトの名前を設定し、[プッシュ削除済みリスナーを設定する] の下にある削除済みリスナーのコールバックメソッドをプッシュします。

プッシュ・リスナーの実装例

次の例では、コールバックメソッド名 PushNotificationReceivedCallback、PushNotificationOpenedCallback、および PushNotificationDeletedCallback をそれぞれ使用して、BrazeCallback ゲームオブジェクトを実装します。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
public class MainMenu : MonoBehaviour {
  void PushNotificationReceivedCallback(string message) {
#if UNITY_ANDROID
    Debug.Log("PushNotificationReceivedCallback message: " + message);
    PushNotification pushNotification = new PushNotification(message);
    Debug.Log("Push Notification received: " + pushNotification);   
#elif UNITY_IOS
    ApplePushNotification pushNotification = new ApplePushNotification(message);
    Debug.Log("Push received Notification event: " + pushNotification);   
#endif  
  }

  void PushNotificationOpenedCallback(string message) {
#if UNITY_ANDROID
    Debug.Log("PushNotificationOpenedCallback message: " + message);
    PushNotification pushNotification = new PushNotification(message);
    Debug.Log("Push Notification opened: " + pushNotification);  
#elif UNITY_IOS
    ApplePushNotification pushNotification = new ApplePushNotification(message);
    Debug.Log("Push opened Notification event: " + pushNotification);   
#endif  
  }

  void PushNotificationDeletedCallback(string message) {
#if UNITY_ANDROID
    Debug.Log("PushNotificationDeletedCallback message: " + message);
    PushNotification pushNotification = new PushNotification(message);
    Debug.Log("Push Notification dismissed: " + pushNotification);  
#endif
  }
}

実施例

Braze Unity SDKリポジトリのサンプルプロジェクトには、FCMを含む完全な動作サンプルアプリが含まれている。

アプリ内リソースへのディープリンク

Braze はデフォルトで標準的なディープリンク (Web サイトのURL、Android の URI など) を処理できますが、カスタムディープリンクを作成するには、追加のマニフェスト設定が必要です。

セットアップガイダンスについては、In-App Resourcesへのディープリンクをご覧ください。

ブレーズプッシュ通知アイコンの追加

プロジェクトにプッシュアイコンを追加するには、アイコンイメージファイルを含むAndroid アーカイブ(AAR) プラグインまたはAndroid ライブラリを作成します。手順と情報については、Unityのドキュメントを参照してください。AndroidライブラリプロジェクトとAndroidアーカイブプラグイン。