バックグラウンド アプリにテスト メッセージを送信する

FCM の手始めとして、シンプルなユースケースを作成します。アプリがデバイスのバックグラウンドで動作しているときに、特定のユーザーに通知メッセージを送信してみましょう。このページには、このチュートリアルに必要なセットアップから検証までのすべての手順が記載されています。JavaScript クライアント アプリでの FCM の設定がすでに済んでいる場合は、一部の手順を省略できます。

SDK を設定する

まだ追加していない場合は、Firebase を JavaScript プロジェクトに追加します

通知の受信許可をリクエストする

Web Notifications API のメソッド Notification.requestPermission() は、ユーザーがブラウザで通知を受け取るためのアクセス許可をアプリに付与できる同意ダイアログを表示します。アクセス許可が拒否された場合、FCM 登録トークン リクエストはエラーになります。

Notification.requestPermission().then((permission) => {
  if (permission === 'granted') {
    console.log('Notification permission granted.');
    // TODO(developer): Retrieve an Instance ID token for use with FCM.
    // ...
  } else {
    console.log('Unable to get permission to notify.');
  }
});

登録トークンにアクセスする

このセクションでは、アプリ インスタンス用の登録トークンを取得する方法と、トークン更新イベントをモニタリングする方法について説明します。トークンは初期起動後にローテーションされている可能性があるため、トークン更新をモニタリングして、更新された最新の登録トークンを常に取得する必要があります。

登録トークンは次のような場合に変更されることがあります。

  • ウェブアプリが登録トークンを削除した場合。
  • ユーザーがブラウザデータをクリアした場合。この場合、新しいトークンを取得するには getToken を呼び出します。

現在の登録トークンの取得

現在のトークンを取得する必要がある場合は、getToken を呼び出します。まだ権限が付与されていない場合、このメソッドは null を返します。そうでない場合は、トークンを返すか、エラーが原因で Promise を拒否します。

メッセージング サービスには firebase-messaging-sw.js ファイルが必要です。firebase-messaging-sw.js ファイルがまだない場合は、トークンを取得する前にこの名前の空のファイルを作成して、ドメインのルートに置きます。クライアント セットアップ プロセスの後半で、このファイルに必要なコンテンツを追加できます。

現在のトークンを取得するには:

// Get Instance ID token. Initially this makes a network call, once retrieved
// subsequent calls to getToken will return from cache.
messaging.getToken().then((currentToken) => {
  if (currentToken) {
    sendTokenToServer(currentToken);
    updateUIForPushEnabled(currentToken);
  } else {
    // Show permission request.
    console.log('No Instance ID token available. Request permission to generate one.');
    // Show permission UI.
    updateUIForPushPermissionRequired();
    setTokenSentToServer(false);
  }
}).catch((err) => {
  console.log('An error occurred while retrieving token. ', err);
  showToken('Error retrieving Instance ID token. ', err);
  setTokenSentToServer(false);
});

トークン更新のモニタリング

新しいトークンが生成されるたびに onTokenRefresh コールバックが呼び出されるため、そのコンテキストで getToken を呼び出すと、利用可能な最新の登録トークンに確実にアクセスできます。

// Callback fired if Instance ID token is updated.
messaging.onTokenRefresh(() => {
  messaging.getToken().then((refreshedToken) => {
    console.log('Token refreshed.');
    // Indicate that the new Instance ID token has not yet been sent to the
    // app server.
    setTokenSentToServer(false);
    // Send Instance ID token to app server.
    sendTokenToServer(refreshedToken);
    // ...
  }).catch((err) => {
    console.log('Unable to retrieve refreshed token ', err);
    showToken('Unable to retrieve refreshed token ', err);
  });
});

トークンを取得したら、それをアプリサーバーに送信して、適切な方法で保管します。インスタンス ID サーバー API を使用して、サブスクリプションに関する情報を取得することができます。

テスト通知メッセージを送信する

  1. ターゲット デバイスでアプリをインストールして実行します。

  2. アプリがデバイスのバックグラウンドで動作していることを確認します。

  3. Notifications Composer を開き、[新しい通知] を選択します。

  4. 通知テキストを入力します。

  5. [テスト メッセージを送信] を選択します。

  6. [FCM 登録トークンを追加] というラベルの付いたフィールドで、このガイドの前のセクションで取得した登録トークンを入力します。

  7. [テスト] をクリックします。

[テスト] をクリックすると、アプリをバックグラウンドで実行しているターゲット クライアント デバイスのブラウザに通知が届きます。

通知ペイロードにウェブプッシュ プロパティを追加する

HTTP v1 API を使用すると、Web Notification API の有効なプロパティを含む JSON オブジェクトとして、追加の通知オプションを指定できます。このオブジェクトの title フィールドと body フィールドが存在する場合、これらのフィールドは同等の google.firebase.fcm.v1.Notification.title フィールドと google.firebase.fcm.v1.Notification.body フィールドをオーバーライドします。

HTTP POST リクエスト

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...PbJ_uNasm

{
  "message": {
    "token" : <token of destination app>,
    "notification": {
      "title": "FCM Message",
      "body": "This is a message from FCM"
    },
    "webpush": {
      "headers": {
        "Urgency": "high"
      },
      "notification": {
        "body": "This is a message from FCM to web",
        "requireInteraction": "true",
        "badge": "/badge-icon.png"
      }
    }
  }
}

このリクエストでは、対象のウェブ クライアント(Android 上で実行されるサポート対象のブラウザを含む)は優先度高の通知メッセージを受信します。これらのメッセージは、ユーザーが操作するまでアクティブな状態になります。このメッセージには、次のフィールドが含まれています。

  • Title: FCM Message
  • Body: This is a message from FCM to web
  • RequireInteraction: true
  • Badge: /badge-icon.png

Android と iOS のネイティブ アプリ(ウェブのオーバーライドが適用されないアプリ)は、通常優先度の通知メッセージを受信します。このメッセージには次のフィールドが含まれます。

  • Title: FCM Message
  • Body: This is a message from FCM

現在、RequireInteraction をサポートしていないブラウザもあります。デベロッパーは、Web Notification API の仕様を参照して、プラットフォームとブラウザでサポートされているかどうか確認する必要があります。

cURL

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...PbJ_uNasm" -H "Content-Type: application/json" -d '{
  "message": {
    "notification": {
      "title": "FCM Message",
      "body": "This is a message from FCM"
    },
    "webpush": {
      "headers": {
        "Urgency": "high"
      },
      "notification": {
        "body": "This is a message from FCM to web",
        "requireInteraction": "true",
        "badge": "/badge-icon.png"
      }
    }
  },
  "token": "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
  }
}' "https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send"

HTTP レスポンス

{
    "name": "projects/myproject-b5ae1/messages/0:1500415314455276%31bd1c9631bd1c98"
}

FCM メッセージの詳細については、アプリサーバーからの送信リクエストを作成するを参照してください。

次のステップ

フォアグラウンドで動作しているアプリへのメッセージの送信

バックグラウンドで動作しているアプリに通知メッセージが正常に送信されたら、JavaScript クライアントでメッセージを受信するを参照して、フォアグラウンドで動作しているアプリへのメッセージの送信を試します。

通知メッセージ以外の動作

通知メッセージだけでなく、他のより高度な動作をアプリに追加する場合は、以下をご確認ください。