トラブルシューティング

Braze/APNsワークフローの理解

Apple Push Notification service（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は、デフォルトの自動フラッシュポリシーを使用するアプリに対して、プッシュトークンを即座に非同期で送信します。ユーザーに関連付けられたプッシュトークンを取得すると、そのユーザーはダッシュボードのユーザープロファイルのエンゲージメントタブに「Push Registered」として表示され、Brazeキャンペーンからプッシュ通知を受信する資格を得ます。

ステップ3：Brazeプッシュキャンペーンの起動

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

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

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

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

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

ここで表示される一般的なエラーには、「未登録のプッシュトークンへの送信を受信」などのユーザー固有の通知が含まれます。

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

プッシュ登録の問題

アプリのプッシュ登録ロジックの検証を追加するには、プッシュユニットテストを実装してください。

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

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

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

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

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

プッシュ通知送信後にユーザーが「プッシュ登録済み」でなくなる

これは、ユーザーのプッシュトークンが無効であることを示している可能性があります。これはいくつかの理由で発生することがあります。

ダッシュボードとアプリの証明書の不一致

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

アンインストール

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

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

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

プッシュ通知送信後もユーザーが「プッシュ登録済み」のままである

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

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

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

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

テスト対象のアプリでユーザーが「プッシュ登録済み」でない

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

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

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

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

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

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

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

デバイストークンがトピックに対応していない

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

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

BadDeviceTokenはAPNsのエラーコードであり、Brazeから発生するものではありません。このレスポンスが返される理由はいくつか考えられ、以下のようなものがあります。

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

プッシュ配信後の問題

アプリのプッシュ処理の検証を追加するには、プッシュユニットテストを実装してください。

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

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

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

iOS 9以降では、Webビューで開くためにリンクがATS準拠である必要があります。WebリンクがHTTPSを使用していることを確認してください。詳細については、ATSコンプライアンスの記事を参照してください。

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

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

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

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

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

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