トラブルシューティング

Braze/APNsのワークフローについて

Apple プッシュ通知サービス（APNs）は、iOS および OS X アプリにプッシュ通知を送信するための Apple のインフラです。ユーザーのデバイスに対してプッシュ通知を有効にする方法と、Brazeがユーザーにプッシュ通知を送信する方法の簡単な構造を次に示します。

1. プッシュ証明書とプロビジョニングプロファイルを構成します
2. デバイスがAPNsに登録し、Brazeにプッシュトークンを提供します
3. Brazeプッシュキャンペーンを開始します
4. Brazeは無効なトークンを削除します

ステップ1:プッシュ証明書とプロビジョニングプロファイルの構成

アプリの開発では、プッシュ通知を有効にするためにSSL証明書を作成する必要があります。この証明書はアプリのビルドに使用されるプロビジョニングプロファイルに含まれ、Brazeダッシュボードにアップロードする必要もあります。証明書を使用すると、Brazeはあなたに代わってプッシュ通知を送信することが許可されていることをAPNsに伝えることができます。

プロビジョニングプロファイルと証明書には、開発と配布の2つのタイプがあります。混乱を避けるために、配布プロファイルと証明書だけを使用することをお勧めします。開発と配布で異なるプロファイルと証明書を使用することを選択した場合は、ダッシュボードにアップロードされた証明書が現在使用しているプロビジョニングプロファイルと一致することを確認してください。

ステップ2:デバイスがAPNsに登録し、Brazeにプッシュトークンを提供します

ユーザーがアプリを開くと、プッシュ通知を受け入れるように求められます。このプロンプトを受け入れると、APNsはその特定のデバイスのプッシュトークンを生成します。iOS SDKは、デフォルトの自動フラッシュポリシーを使用して、アプリのプッシュトークンを直ちに非同期に送信します。ユーザーにプッシュトークンが関連付けられると、ダッシュボードのエンゲージメントタブのユーザープロファイルに「プッシュ登録済み」と表示され、BrazeのCampaignsからプッシュ通知を受け取る資格が得られます。

ステップ3:Brazeプッシュキャンペーンの開始

プッシュキャンペーンが開始されると、BrazeはAPNsにメッセージの配信リクエストを行います。Brazeは、ダッシュボードにアップロードされたSSLプッシュ証明書を使用して認証を行い、提供されたプッシュトークンへのプッシュ通知の送信が許可されていることを確認します。デバイスがオンラインの場合は、キャンペーンが送信された後すぐに通知が受信されます。なお、Brazeは通知のデフォルトのAPNs有効期限を30日に設定しています。

ステップ4:無効なトークンの削除

APNsが、メッセージを送信しようとしていたプッシュトークンのいずれかが無効であることを通知した場合、それらのトークンは関連付けられたユーザープロファイルから削除されます。

プッシュエラーログの活用

Brazeは、メッセージアクティビティログ内にプッシュ通知エラーのログを提供します。このエラーログは、Campaignsが期待どおりに機能していない理由を特定するのに非常に役立つさまざまな警告を提供します。エラーメッセージをクリックすると、特定のインシデントのトラブルシューティングに役立つ関連ドキュメントにリダイレクトされます。

ここでよく見かけるエラーとしては、「プッシュトークンへの未登録送信を受信」など、ユーザー固有の通知があります。

さらに、Brazeはエンゲージメントタブのユーザープロファイルにプッシュ通知の変更ログも提供します。この変更ログは、トークンの無効化、プッシュ登録エラー、トークンの新規ユーザーへの移動などのプッシュ登録動作に関するインサイトを提供します。

プッシュ登録に関する問題

アプリケーションのプッシュ登録ロジックの検証を追加するには、プッシュユニットテストを実装します。

プッシュ登録プロンプトが表示されない

アプリケーションでプッシュ通知の登録を求めるメッセージが表示されない場合は、プッシュ登録の統合に問題がある可能性があります。ドキュメントに従っており、プッシュ登録が正しく統合されていることを確認してください。コードにブレークポイントを設定して、プッシュ登録コードが実行されていることを確認することもできます。

ダッシュボードに「プッシュ登録済み」ユーザーが表示されない

• アプリがプッシュ通知を許可するように求めるメッセージを表示していることを確認します。通常、このプロンプトはアプリを初めて起動したときに表示されますが、他の場所に表示されるようにプログラムすることもできます。表示されるべき場所に表示されない場合は、アプリのプッシュ機能の基本構成に問題がある可能性があります。
  • プッシュ統合の手順が正常に完了したことを確認します。
  • アプリのビルドに使用されたプロビジョニングプロファイルにプッシュの権限が含まれていることを確認します。Apple開発者アカウントから利用可能なプロビジョニングプロファイルをすべてプルダウンしていることを確認してください。これを確認するには、次の手順を実行します。
    1. Xcodeで、Preferences > Accounts に移動します（または、キーボードショートカットCommand+,を使用します）。
    2. 開発者アカウントに使用するApple IDを選択し、View Detailsをクリックします。
    3. 次のページで、 Refreshをクリックし、使用可能なすべてのプロビジョニングプロファイルをプルしていることを確認します。
• アプリでプッシュ機能が適切に有効化されていることを確認します。
• プッシュプロビジョニングプロファイルがテスト環境と一致することを確認します。ユニバーサル証明書は、開発または本番のAPNs環境のいずれかに送信するようにBrazeダッシュボードで構成できます。本番アプリ用の開発証明書または開発アプリ用の本番証明書は動作しません。
• コードにブレークポイントを設定して、registerPushTokenメソッドを呼び出していることを確認します。
• デバイス上にあり（シミュレーター上ではプッシュが機能しません）、ネットワーク接続が良好であることを確認します。

デバイスがプッシュ通知を受信しない

プッシュ通知の送信後にユーザーが「プッシュ登録」されなくなった

これは、ユーザーが無効なプッシュトークンを持っていたことを示している可能性があります。これにはいくつかの理由が考えられます。

ダッシュボードとアプリ証明書が一致していない

ダッシュボードでアップロードしたプッシュ証明書が、アプリのビルドに使用したプロビジョニングプロファイルのものと異なる場合、APNsはトークンを拒否します。別のテスト通知を試みる前に、正しい証明書をアップロードし、アプリで別のセッションを完了していることを確認します。

アンインストール

ユーザーがアプリケーションをアンインストールした場合、プッシュトークンは無効となり、次回の送信時に削除されます。

プロビジョニングプロファイルの再生成

最後の手段として、最初からやり直してまったく新しいプロビジョニングプロファイルを作成すると、複数の環境、プロファイル、およびアプリを同時に操作することによって発生する構成エラーを解消できます。iOSアプリのプッシュ通知の設定は「動く部分」が多いので、最初からやり直したほうがいい場合もあります。また、トラブルシューティングを続ける必要がある場合は、問題を切り分けるのに役立ちます。

プッシュ通知を送信した後もユーザーが「プッシュ登録」されている

アプリがフォアグラウンドにある

UserNotificationsフレームワークを介してプッシュを統合していないiOSバージョンでは、プッシュメッセージの受信時にアプリがフォアグラウンドにある場合、そのメッセージは表示されません。テストメッセージを送信する前に、テストデバイスでアプリをバックグラウンドにする必要があります。

テスト通知のスケジュールが正しくない

テストメッセージに設定したスケジュールを確認します。ローカルタイムゾーン配信またはインテリジェントタイミングに設定されている場合、メッセージがまだ受信されていない（または受信時にアプリがフォアグラウンドにあった）だけかもしれません。

テスト対象のアプリに対してユーザーが「プッシュ登録」されていない

テストメッセージを送信しようとしている相手のユーザープロファイルを確認します。エンゲージメントタブの下に「プッシュ可能なアプリ」のリストがあるはずです。テストメッセージを送信しようとしているアプリがこのリストにあることを確認します。ユーザーがワークスペース内の任意のアプリのプッシュトークンを持っている場合は「プッシュ登録済み」と表示されるため、誤検知の可能性があります。

以下は、プッシュ登録に問題があるか、プッシュ後にユーザーのトークンがAPNsによって無効としてBrazeに返されたことを示しています。

プッシュメッセージが送信されない

送信されないプッシュ通知のトラブルシューティングについては、「プッシュのトラブルシューティング」を参照してください。

メッセージアクティビティログのエラー

プッシュトークンへの未登録送信を受信した

• メソッド[[Appboy sharedInstance] registerPushToken:]からBrazeに送信されているプッシュトークンが有効であることを確認してください。メッセージアクティビティログを見ると、プッシュトークンを確認できます。これは6e407a9be8d07f0cdeb9e724733a89445f57a89ec890d63867c482a483506fa6のようになり、文字と数字が混在する長い文字列になります。プッシュトークンが異なるように見える場合は、Brazeにプッシュトークンを送信するためのコードを確認してください。
• プッシュプロビジョニングプロファイルがテスト対象の環境と一致することを確認します。ユニバーサル証明書は、開発または本番のAPNs環境のいずれかに送信するようにBrazeダッシュボードで構成できます。本番アプリ用の開発証明書または開発アプリ用の本番証明書は動作しません。
• Brazeにアップロードしたプッシュトークンが、プッシュトークンの送信元のアプリのビルドに使用したプロビジョニングプロファイルと一致することを確認します。

デバイストークンがトピック用ではない

このエラーは、アプリのプッシュ証明書とバンドルIDが一致しないことを示しています。Brazeにアップロードしたプッシュ証明書が、プッシュトークンの送信元となるアプリのビルドに使用したプロビジョニングプロファイルと一致することを確認してください。

プッシュトークンへのBadDeviceTokenの送信

BadDeviceTokenはAPNsのエラーコードであり、Brazeから発信されたものではありません。この応答が返される理由としては、次のようなものが考えられます。

• アプリが、ダッシュボードにアップロードされた認証情報に対して無効なプッシュトークンを受け取った。
• このワークスペースではプッシュが無効になっていた。
• ユーザーがプッシュをオプトアウトした。
• アプリがアンインストールされた。
• Appleがプッシュトークンを更新したため、古いトークンが無効になった。
• アプリは本番環境用にビルドされていますが、Brazeにアップロードされたプッシュ認証情報は開発環境用に設定されています（または逆の場合もあります）。

プッシュ配信後の問題

アプリケーションのプッシュ処理の検証を追加するには、プッシュユニットテストを実装します。

プッシュクリックが記録されない

• これがiOS 10でのみ発生する場合は、iOS 10のプッシュ統合手順に従っていることを確認してください。
• Brazeでは、フォアグラウンドでサイレント受信したプッシュ通知（UserNotificationsフレームワーク以前のデフォルトのフォアグラウンドプッシュ動作など）は処理されません。つまり、リンクは開かれず、プッシュクリックは記録されません。アプリケーションがUserNotificationsフレームワークをまだ統合していない場合、アプリケーション状態がUIApplicationStateActiveのときにBrazeはプッシュ通知を処理しません。アプリがプッシュ処理メソッドへの呼び出しを遅延しないようにしてください。遅延した場合、iOS SDKはプッシュ通知をサイレントフォアグラウンドプッシュイベントとして扱い、処理しないことがあります。

プッシュクリックからのWebリンクが開かない

iOS 9以降では、ウェブビューで開くにはATS準拠のリンクが必要です。WebリンクがHTTPSを使用していることを確認してください。詳細については、ATS準拠の記事を参照してください。

プッシュクリックからディープリンクが開かない

ディープリンクを扱うコードのほとんどはプッシュ通知の開封も扱います。まず、プッシュ通知の開封がログに記録されていることを確認します。記録されていない場合は、その問題を修正してください（多くの場合、修正によりリンク処理も修正されます）。

開封が記録されている場合は、ディープリンク全般の問題なのか、ディープリンクのプッシュクリック処理の問題なのかを確認してください。そのためには、アプリ内メッセージクリックからのディープリンクが機能するかテストします。

直接開封がほとんどない、または全くない

iOSプッシュ通知を開封したユーザーが1人以上いるにもかかわらず、Brazeに直接開封のログがほとんど残っていない場合、SDKの統合に問題がある可能性があります。テスト送信またはサイレントプッシュ通知については、直接開封はログに記録されません。

• メッセージがサイレントプッシュ通知として送信されていないことを確認します。メッセージがサイレントと見なされないようにするには、タイトルまたは本文にテキストを含める必要があります。
• プッシュ統合ガイドから以下のステップを再確認してください。
  • プッシュを登録する:アプリを起動するたびに、できればapplication:didFinishLaunchingWithOptions:内で、ステップ3のコードを実行する必要があります。UNUserNotificationCenter.current()のdelegateプロパティは、UNUserNotificationCenterDelegateを実装し、(void)userNotificationCenter:didReceiveNotificationResponse:withCompletionHandler:メソッドを含むオブジェクトに割り当てる必要があります。
  • プッシュ処理を有効にする:(void)userNotificationCenter:didReceiveNotificationResponse:withCompletionHandler:メソッドが実装されていることを確認してください。