エンゲージメント

【PlayFab】プッシュ通知を実装する方法【Android編】

playfab-push-notification-android

PlayFab から Android 端末にプッシュ通知を送る手順について解説した記事です。

プッシュ通知の概要や iOS の実装については、プッシュ通知を実装する方法【iOS編】を参照してください。

では、さっそく見ていきましょう。

プッシュ通知を実装する方法【Android編】

この記事は、Android のプッシュ通知を参考に作成しています。

Firebase の準備

Firebase の公式ドキュメントも合わせて参照してください。

私は以下の内容で新規プロジェクトを作成しました。

  • 名前は PlayFabTest
  • Google Analytics は使用しない

すると以下の画面になるので、Unity のマークを選択してください。

playfab-push-notification-android

今回は Android を登録するので、「Register as Android app」にチェックを付けます。

必要な情報を入力して、アプリを登録しましょう。

playfab-push-notification-android

設定ファイルのダウンロードは公式の手順のとおりなので、そのまま進めてください。

playfab-push-notification-android

次に、SDK のダウンロードをします。

playfab-push-notification-android
ねこじょーかー
ねこじょーかー
SDK のサイズは約300MB と書いてありますが、実際は 2.3GB もありました(笑)

解凍して中身を見ると、たくさんの unitypackage が入っています。

最低限インポートが必要なのは、「dotnet4¥FirebaseMessaging.unitypackage」です。

playfab-push-notification-android

こちらをインポートしましょう。

playfab-push-notification-android

すると、統計情報を Google に送るかの確認がでてきます。

どちらでもいいですが、私は No にしました。

playfab-push-notification-android

以下の画面は何なのかあまり理解できていませんが、「Add Selected Registries」としておきました。

playfab-push-notification-android

次はリストが空になっている気がするので Cancel でも問題ないと思いますが、とりあえず Apply をしておきました。

playfab-push-notification-android

これで unitypackage のインポートは完了です。

Firebase に戻ると以下の画面になるので、コンソールに進みましょう。

playfab-push-notification-android

最後に、サーバーキーをコピーしておきます。

  1. 歯車マーク > プロジェクトを設定
  2. クラウドメッセージングのタブ
  3. サーバーキーをコピー
playfab-push-notification-android

これで、Firebase の準備は完了しました。

PlayFab との連携

Firebase と PlayFab を連携します。

PlayFab 管理画面を開き、「タイトルの設定 > プッシュ通知」と進み、Android の設定を選択します。

playfab-push-notification-android

先ほどコピーした Firebase のサーバーキーをペーストし、「プッシュ通知を登録」を押しましょう。

playfab-push-notification-android

Android がアクティブになっていたら成功です。

playfab-push-notification-android
エラーが出てプッシュ通知を登録できない…

PlayFab 公式コミュニティによると、タイトルの名前が他のユーザーと重複する場合、必ずエラーとなるようです。

私は最初「TestTitle」という名前でしたが、エラーで登録できませんでした。

しかし、この名前を「TestTitle_1234」に変更することで、無事に登録することができました。(けっこう詰まった…)

エラーの文言がわかりにくいので、気をつけてください。

プッシュ通知テンプレートの登録

この手順については、プッシュ通知を実装する方法【iOS編】を参照してください。

クライアント側の実装

クライアント側は以下のように実装します。

ログイン処理がよくわからない場合は、何も考えずにログイン処理を実装する記事を参照してみてください。
public void OnGUI()
{
    GUI.Label(new Rect(0, 0, Screen.width, 200), pushToken);
    GUI.Label(new Rect(0, 200, Screen.width, Screen.height - 200), lastMsg);
}
public void Start()
{
    Firebase.Messaging.FirebaseMessaging.TokenReceived += OnTokenReceived;
    Firebase.Messaging.FirebaseMessaging.MessageReceived += OnMessageReceived;

    PlayFabAuthService.OnLoginSuccess += PlayFabAuthService_OnLoginSuccess;
    PlayFabAuthService.Instance.Authenticate(Authtypes.Silent);
}
private void PlayFabAuthService_OnLoginSuccess(LoginResult result)
{
    Debug.Log("Login Success!!");
    RegisterForPush();
}

private void RegisterForPush()
{
    if (string.IsNullOrEmpty(pushToken))
        return;

#if UNITY_ANDROID
    var request = new AndroidDevicePushNotificationRegistrationRequest
    {
        DeviceToken = pushToken,
        SendPushNotificationConfirmation = true,
        ConfirmationMessage = "Push notifications registered successfully"
    };
    PlayFabClientAPI.AndroidDevicePushNotificationRegistration(request
        , result => { Debug.Log("PlayFab: Push Registration Successful"); }
        , error => { Debug.Log(error.GenerateErrorReport()); });
#endif
}

private void OnTokenReceived(object sender, Firebase.Messaging.TokenReceivedEventArgs token)
{
    Debug.Log("PlayFab: Received Registration Token: " + token.Token);
    pushToken = token.Token;
    RegisterForPush();
}

private void OnMessageReceived(object sender, Firebase.Messaging.MessageReceivedEventArgs e)
{
    Debug.Log("PlayFab: Received a new message from: " + e.Message.From);
    lastMsg = "";
    if (e.Message.Data != null)
    {
        lastMsg += "DATA: " + PlayFabSimpleJson.SerializeObject(e.Message.Data) + "\n";
        Debug.Log("PlayFab: Received a message with data:");
        foreach (var pair in e.Message.Data)
            Debug.Log("PlayFab data element: " + pair.Key + "," + pair.Value);
    }
    if (e.Message.Notification != null)
    {
        Debug.Log("PlayFab: Received a notification:");
        lastMsg += "TITLE: " + e.Message.Notification.Title + "\n";
        lastMsg += "BODY: " + e.Message.Notification.Body + "\n";
    }
}

長々と書いていますが、ほとんどログ出力の処理なので、重要なのは以下の部分だけです。

  • Firebase のイベントを紐付ける
  • PlayFab アカウントに端末を登録する

Firebase のイベントを紐付ける

Firebase.Messaging.FirebaseMessaging.TokenReceived += OnTokenReceived;
Firebase.Messaging.FirebaseMessaging.MessageReceived += OnMessageReceived;

トークンは、PlayFab に端末を登録するために必要なので、イベントを紐付けます。

メッセージ受信のイベントは、サーバーから受け取ったプッシュ通知を受け取るためのイベントです。

アプリを使用していない場合はプッシュ通知として受け取りますが、使用中は受け取りできません。

このイベントを紐付けておくと、アプリ使用中でもメッセージを受け取ることができます。

PlayFab アカウントに端末を登録する

    var request = new AndroidDevicePushNotificationRegistrationRequest
    {
        DeviceToken = pushToken,
        SendPushNotificationConfirmation = true,
        ConfirmationMessage = "Push notifications registered successfully"
    };
    PlayFabClientAPI.AndroidDevicePushNotificationRegistration(request
        , result => { Debug.Log("PlayFab: Push Registration Successful"); }
        , error => { Debug.Log(error.GenerateErrorReport()); });

Android Device Push Notification Registration という長いメソッドを使用して登録します。

SendPushNotificationConfirmation を true にしておくと、登録後に ComfirmationMessage で設定したメッセージを受信できます。

このメッセージは、アプリ使用中であれば、OnGUI() で用意しているラベルに表示される仕組みです。

テスト動作確認

ここでいったん、テスト動作を確認していきます。

クライアントを実装した状態で Unity を実行すると、タイトルプレイヤーアカウントに以下が追加されます。

playfab-push-notification-android
ペンギンくん
ペンギンくん
Android は通知を許可するのが初期値みたいだね!
ねこじょーかー
ねこじょーかー
iOS のような通知許可の確認メッセージは出ないみたい。

プッシュ通知を送信のボタンを押すことで、テンプレートの通知を送ることができます。

灰色のバッジアイコンがつくのも確認しました。

プッシュ通知
playfab-push-notification-android
バッジアイコン
playfab-push-notification-android

いい感じですね。

アプリ使用中であれば、アプリ画面にメッセージが表示されます。

運用シーンを想定した実装

ここからは、プッシュ通知を使う実際の運用を想定して実装していきます。

内容としては、プッシュ通知を実装する方法【iOS編】と同じになるので、そちらを参照してください。

セグメントのプレイヤーの条件が、Android に置き換わるくらいの違いですね。

これでひと通り実装が完了しました。

最後に

PlayFab で Android のプッシュ通知をする方法について解説しました。

iOS では Firebase を使わずに実装できる仕様なのが、少し謎ですね。

それなら iOS も Firebase からプッシュ通知を送ったほうが処理が統一できそうですが、まだ試してはいません。

この記事を参考に、ぜひプッシュ通知を実装してみてください。

オンライン書籍「猫でもわかる PlayFab 入門」
playfab-book

日本で初めて、PlayFab の参考書を発売しました。

100時間以上の学習内容を凝縮した参考書です。入門として必要な知識は、すべてこの本に記載しました。

 

COMMENT

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です