このページは Cloud Translation API によって翻訳されました。

Codelab: プッシュ通知クライアントを作成する

Kate Jeffreys

Kayce Basques

この Codelab では、プッシュ通知クライアントをビルドする方法を順を追って説明します。この Codelab を終了すると、次のクライアントが作成されます。

ユーザーをプッシュ通知に登録します。
プッシュメッセージを受信し、通知として表示します。
プッシュ通知からユーザーの登録を解除します。

この Codelab は、実践による学習を支援することに重点を置いており、コンセプトについてはあまり説明しません。プッシュ通知のコンセプトについては、プッシュ通知の仕組みをご覧ください。

この Codelab のサーバーコードはすでに完成しています。この Codelab ではクライアントのみを実装します。プッシュ通知サーバーを実装する方法については、Codelab: プッシュ通知サーバーを作成するをご覧ください。

完全なコードを確認するには、push-notifications-client-codelab-complete（ソース）をご覧ください。

ブラウザの互換性

この Codelab は、次のオペレーティングシステムとブラウザの組み合わせで動作することが確認されています。

Windows: Chrome、Edge
macOS: Chrome、Firefox
Android: Chrome、Firefox

この Codelab は、次のオペレーティングシステム（またはオペレーティングシステムとブラウザの組み合わせ）では機能しないことが確認されています。

macOS: Brave、Edge、Safari
iOS

セットアップ

コードの編集可能なコピーを取得する

手順の右側に表示されるコードエディタを、この Codelab では「Glitch UI」と呼びます。

[Remix to Edit] をクリックして、プロジェクトを編集可能にします。

認証を設定する

プッシュ通知を機能させるには、認証キーを使用してサーバーとクライアントを設定する必要があります。その理由については、ウェブの push プロトコルリクエストに署名するをご覧ください。

Glitch UI で [Tools] をクリックし、次に [Terminal] をクリックして、Glitch Terminal を開きます。
Glitch ターミナルで npx web-push generate-vapid-keys を実行します。秘密鍵と公開鍵の値をコピーします。
Glitch UI で .env を開き、VAPID_PUBLIC_KEY と VAPID_PRIVATE_KEY を更新します。VAPID_SUBJECT を mailto:test@test.test に設定します。これらの値はすべて二重引用符で囲む必要があります更新すると、.env ファイルは次のようになります。

VAPID_PUBLIC_KEY="BKiwTvD9HA…"
VAPID_PRIVATE_KEY="4mXG9jBUaU…"
VAPID_SUBJECT="mailto:test@test.test"

Glitch ターミナルを閉じます。

環境変数の値（.env の内容）は、1 つの Glitch プロジェクトに固有のものです。プロジェクトをリミックスする場合、.env の値はコピーされません。

public/index.js を開きます。
VAPID_PUBLIC_KEY_VALUE_HERE は、公開鍵の値に置き換えます。

Service Worker を登録する

クライアントで通知を受信して表示するために、最終的には Service Worker が必要になります。Service Worker はできるだけ早く登録することをおすすめします。詳細については、プッシュされたメッセージを通知として受信して表示するをご覧ください。

// TODO add startup logic here コメントを次のコードに置き換えます。

// TODO add startup logic here
if ('serviceWorker' in navigator && 'PushManager' in window) {
  navigator.serviceWorker.register('./service-worker.js').then(serviceWorkerRegistration => {
    console.info('Service worker was registered.');
    console.info({serviceWorkerRegistration});
  }).catch(error => {
    console.error('An error occurred while registering the service worker.');
    console.error(error);
  });
  subscribeButton.disabled = false;
} else {
  console.error('Browser does not support service workers or push messages.');
}

subscribeButton.addEventListener('click', subscribeButtonHandler);
unsubscribeButton.addEventListener('click', unsubscribeButtonHandler);

サイトをプレビューするには、[View App] を押してから、[Fullscreen] を押します。

Ctrl+Shift+J キー（Mac の場合は Command+Option+J キー）を押して DevTools を開きます。
[Console]（コンソール）タブをクリックします。コンソールにログ「Service worker was registered.」というメッセージが表示されます。

プッシュ通知権限をリクエストする

ページの読み込み時にプッシュ通知を送信する権限をリクエストしないでください。代わりに、UI でプッシュ通知を受信するかどうかをユーザーに尋ねる必要があります。デベロッパーが（ボタンのクリックなどによって）明示的に確認したら、ブラウザからプッシュ通知の権限を取得するための正式なプロセスを開始できます。

Glitch UI で [View Source] をクリックしてコードに戻ります。
public/index.js で、subscribeButtonHandler() の // TODO コメントを次のコードに置き換えます。

// TODO
// Prevent the user from clicking the subscribe button multiple times.
subscribeButton.disabled = true;
const result = await Notification.requestPermission();
if (result === 'denied') {
  console.error('The user explicitly denied the permission request.');
  return;
}
if (result === 'granted') {
  console.info('The user accepted the permission request.');
}

アプリのタブに戻り、[Subscribe to push] をクリックします。ブラウザやオペレーティングシステムから、プッシュ通知の送信を許可するかどうかを尋ねられることがあります。[許可]（またはブラウザや OS が使用する同等のフレーズ）をクリックします。コンソールに、リクエストが承認されたか拒否されたかを示すメッセージが表示されます。

プッシュ通知に登録する

サブスクリプションプロセスには、ブラウザベンダーが管理するウェブサービス（push サービスと呼ばれる）とのやり取りが含まれます。プッシュ通知の登録情報を取得したら、それをサーバーに送信し、サーバーで長期にわたってデータベースに保存する必要があります。購読プロセスの詳細については、クライアントをプッシュ通知に登録するをご覧ください。

以下のハイライト表示されたコードを subscribeButtonHandler() に追加します。

subscribeButton.disabled = true;
const result = await Notification.requestPermission();
if (result === 'denied') {
  console.error('The user explicitly denied the permission request.');
  return;
}
if (result === 'granted') {
  console.info('The user accepted the permission request.');
}
const registration = await navigator.serviceWorker.getRegistration();
const subscribed = await registration.pushManager.getSubscription();
if (subscribed) {
  console.info('User is already subscribed.');
  notifyMeButton.disabled = false;
  unsubscribeButton.disabled = false;
  return;
}
const subscription = await registration.pushManager.subscribe({
  userVisibleOnly: true,
  applicationServerKey: urlB64ToUint8Array(VAPID_PUBLIC_KEY)
});
notifyMeButton.disabled = false;
fetch('/add-subscription', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(subscription)
});

userVisibleOnly オプションは true にする必要があります。いつかは、ユーザーに表示される通知（サイレントプッシュ）を表示せずにメッセージをプッシュできるようになる場合もありますが、プライバシーに関する懸念からブラウザは現在この機能を許可していません。

applicationServerKey 値は、base64 文字列を Uint8Array に変換するユーティリティ関数に依存します。この値は、サーバーと push サービス間の認証に使用されます。

プッシュ通知の登録を解除

ユーザーがプッシュ通知に登録した後、ユーザーの気が変わってプッシュ通知を受け取りたくない場合に備えて、UI で配信停止の方法を提供する必要があります。

unsubscribeButtonHandler() の // TODO コメントを次のコードに置き換えます。

// TODO
const registration = await navigator.serviceWorker.getRegistration();
const subscription = await registration.pushManager.getSubscription();
fetch('/remove-subscription', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({endpoint: subscription.endpoint})
});
const unsubscribed = await subscription.unsubscribe();
if (unsubscribed) {
  console.info('Successfully unsubscribed from push notifications.');
  unsubscribeButton.disabled = true;
  subscribeButton.disabled = false;
  notifyMeButton.disabled = true;
}

プッシュメッセージを受信して通知として表示する

前述のように、サーバーからクライアントに push されたメッセージを受信して表示するには、Service Worker が必要です。詳細については、push されたメッセージを通知として受信して表示するをご覧ください。

public/service-worker.js を開き、Service Worker の push イベントハンドラの // TODO コメントを次のコードに置き換えます。

// TODO
let data = event.data.json();
const image = 'https://cdn.glitch.com/614286c9-b4fc-4303-a6a9-a4cef0601b74%2Flogo.png?v=1605150951230';
const options = {
  body: data.options.body,
  icon: image
}
self.registration.showNotification(
  data.title, 
  options
);

アプリのタブに戻ります。
[通知を受け取る] をクリックします。プッシュ通知が届きます。
他のブラウザ（または他のデバイス）でアプリのタブの URL を開き、購読ワークフローを実行してから、[すべて通知] をクリックしてみてください。登録したすべてのブラウザに、同じプッシュ通知が送信されます。ブラウザの互換性に戻り、動作することが確認されているブラウザと OS の組み合わせのリストを確認します。

通知はさまざまな方法でカスタマイズできます。詳細については、ServiceWorkerRegistration.showNotification() のパラメータをご覧ください。

Service Worker の install リスナーでの self.skipWaiting() の呼び出しについて理解しておくことが重要です。詳細については、待機フェーズをスキップするをご覧ください。これを行わないと、Service Worker に加えた変更が直ちに有効になりません。ニーズに応じて、この機能を自社のウェブサイトで使用する場合もあれば、使用しない場合もありますが、いずれにしてもその効果を理解することが重要です。

ユーザーが通知をクリックしたときに URL を開く

実際には、ユーザーに再度働きかけてサイトへのアクセスを促す方法として、通知を使用するのが一般的です。そのためには、Service Worker をもう少し構成する必要があります。

Service Worker の notificationclick イベントハンドラの // TODO コメントを次のコードに置き換えます。

// TODO
event.notification.close();
event.waitUntil(self.clients.openWindow('https://web.dev'));

アプリのタブに戻り、別の通知を自分に送ってから、通知をクリックします。ブラウザで新しいタブが開いて https://web.dev が読み込まれます。

次のステップ

通知をカスタマイズするさまざまな方法については、ServiceWorkerRegistration.showNotification() をご覧ください。
プッシュ通知の仕組みに関するコンセプトについて詳しくは、プッシュ通知の概要をご覧ください。
Codelab: プッシュ通知サーバーを作成するで、定期購入を管理し、ウェブ push プロトコルリクエストを送信するサーバーを構築する方法を確認する。
通知生成ツールを試して、通知をカスタマイズするすべての方法をテストします。