Firebase In-App Messaging を使って特定のユーザーにメッセージを通知する

アクティブなユーザーに対してカスタマイズ可能なメッセージを表示させることができるFirebaseのサービスです。iOSアプリ開発で実際に使ってみた過程を記事にします。

#iPhone

#Firebase

#Firebase In-App Messaging

田辺信之

2019.08.21

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

クラスメソッド福岡オフィスでiOSアプリエンジニアとして働いている田辺です。先日業務で Firebase の In-App Messaging に触れる機会がありました。今回は特定の属性をもつユーザーに対して通知を行うところまでをやってみたので、基本的なところから説明しながら記事にしていきます。

In-App Messagingとは

アクティブなユーザーへのメッセージの表示を行うことができるサービスです。Firebase コンソールからメッセージのデザインをカスタマイズできます。タイトルやボディ、テキストや色などが設定できます。

ルーティング先のURLを設定することでボタンが押下されたときに遷移処理を行えます。

The Firebase Blog: Introducing Firebase In-App Messagingによると、アプリ内メッセージングで送信されるメッセージの主な目的は、アクティブなユーザーをアプリ内の主要なアクション（購読、ビデオの視聴、レベルの完了、アイテムの購入など）を行うよう背中を押すこととあります。

また、Firebase Cloud Messagingを介して送信されるメッセージを補完するものと位置付けられています。

検証環境

Xcode Version 10.3
Swift5.0
iOS 10.3
CocoaPods 1.7.5

iOS のバージョンは機能改修中のアプリケーションの iOS のバージョンになります。

導入

今回はCocoaPodsを使って導入します。

Podfileに以下のように追記します。

  pod 'Firebase/InAppMessagingDisplay'

その後、pod installというコマンドを実行します。

installに成功した後は、AppDelegate.swiftでFirebaseApp.configure()と記述します。これでアプリケーション側のセットアップは終了です。

Firebase コンソール

Firebase コンソールの左カラムの拡大（Growth）にあるIn-App Messagingをクリックします。

その後、最初のキャンペーンを作成をクリックします。

次のような設定画面に遷移します。

次へを押すとスタイルと内容を設定した後はメッセージを表示するユーザーを設定します。

今回はテストのためアプリケーションをインストールしているユーザーすべてを対象にしたので潜在的ユーザーの100%がこのキャンペーンの対象になっていますというテキストが表示されています。

次へを押すとスケジュールの設定画面が表示されます。メッセージが表示される期間の設定をまず行います。デフォルトでは終了日は指定されていないので指定した頻度で繰り返し表示されます。

また、Firebase Analyticsを使ってイベントをロギングしている場合はイベントをトリガーにメッセージを表示させることができます。Firebase Analyticsのロギングに関する記述は本筋とは関係がないので割愛しますが、今回のアプリケーションではアプリケーション起動時をイベントとして設定しています。

入力は任意になっていますが、インプレッション、クリック数にコンバージョンイベントを紐付けられます。今回は設定しません。

設定が済んだら公開を押して問題なければ終了です。

適切に設定が行えていたらダッシュボードに作成したキャンペーンが表示されています。

これでアプリケーションの起動時にメッセージが表示されるはずです。

表示されました。

テストメッセージの送信

Firebase In-App Messagingはメッセージの取得を１日に１回だけ行いますが、テストを行うためにメッセージをオンデマンドで表示するテストデバイスをFirebaseコンソールから指定できます。 Firebase アプリ内メッセージングを使ってみる | Firebaseによると、必要な情報はアプリのインスタンスID（FirebaseInstanceID）です。

アプリケーションのインスタンスIDの取得

Xcodeプロジェクトを開いてメニューバーのProduct > Scheme > Edit Schemeの順に選択してダイアログのArgumentsタブを開きます。

Arguments Passed On Lanuch で +ボタンをクリックしてフィールドに-FIRDebugEnabledと入力してCloseを押します。

次のようになっていればOKです。

その後アプリケーションを実行すると[Firebase/InAppMessaging][I-IAM180017] Starting InAppMessaging runtime with Instance ID xxxxxxxxxxxxxというログが出ているはずなのでこのIDをメモしておきます。

その後ダッシュボードからデバイスでテストを選択して表示されたポップアップで、インスタンスIDを追加してテストをクリックします。

テストデバイスにメッセージを送る

テストをクリックするとすぐにFirebaseアプリケーション内メッセージングからテスト用のメッセージが送信されます。表示するにはインスタンスIDを登録したデバイスでアプリケーションを閉じて再度開きます。

するとテストデバイスにメッセージが配信されるので表示の確認が行えます。

このテストデバイスにメッセージを配信する部分の手順はドキュメントに記載されています。

しかし、手順とおりにデバイスにメッセージを配信するためにアプリケーションを実行すると、[NSBundle initWithURL:]: nil URL argument'というエラーを吐きクラッシュするというIssueが2つありました。もしクラッシュする場合は参考にしてみるとよいかもしれません。