chrome.gcm

更新日: 2026-09-25 robots: noindex

説明

chrome.gcm を使用すると、アプリや拡張機能で Firebase Cloud Messaging（FCM）を介してメッセージを送受信できるようになります。

権限

gcm

プロパティ

MAX_MESSAGE_SIZE

メッセージ内のすべての Key-Value ペアの最大サイズ（バイト単位）。

値

4096

メソッド

register()

Promise

chrome.gcm.register(
  senderIds: string[],
  callback?: function,
): Promise<string>

アプリケーションを FCM に登録します。登録 ID は callback によって返されます。同じ senderIds のリストを使用して register が再度呼び出されると、同じ登録 ID が返されます。

パラメータ

• senderIds

  string[]

  アプリケーションにメッセージを送信できるサーバー ID のリスト。1 ～ 100 個の送信者 ID を含める必要があります。

• callback

  function 省略可

  callback パラメータは次のようになります。

  (registrationId: string) => void

  • registrationId

    文字列

    FCM によってアプリケーションに割り当てられた登録 ID。

戻り値

• Promise<string>

  Chrome 116 以降

  登録が完了すると解決されます。

  Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

send()

Promise

chrome.gcm.send(
  message: object,
  callback?: function,
): Promise<string>

内容に応じてメッセージを送信します。

パラメータ

• メッセージ

  オブジェクト

  FCM を介して相手に送信するメッセージ。

  • データ

    オブジェクト

    サーバーに送信するメッセージ データ。大文字と小文字を区別しない goog. と google、および大文字と小文字を区別する collapse_key は、キーの接頭辞として使用できません。すべての Key-Value ペアの合計は gcm.MAX_MESSAGE_SIZE 以下にする必要があります。

  • destinationId

    文字列

    Google API Console で割り当てられた、メッセージの送信先サーバーの ID。

  • messageId

    文字列

    メッセージの ID。アプリケーションのスコープ内のメッセージごとに一意である必要があります。ID の選択と処理に関するアドバイスについては、Cloud Messaging のドキュメントをご覧ください。

  • timeToLive

    number 省略可

    メッセージの有効期間（秒単位）。この時間内にメッセージを送信できない場合は、onSendError イベントが発生します。有効期間が 0 の場合、メッセージはすぐに送信されるか、送信できない場合は失敗します。有効期間のデフォルト値は 86,400 秒（1 日）で、最大値は 2,419,200 秒（28 日）です。

• callback

  function 省略可

  callback パラメータは次のようになります。

  (messageId: string) => void

  • messageId

    文字列

    コールバックが発行されたメッセージの ID。

戻り値

• Promise<string>

  Chrome 116 以降

  メッセージが送信キューに正常に追加されると解決されます。エラーが発生すると、Promise は拒否されます。

  Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

unregister()

Promise

chrome.gcm.unregister(
  callback?: function,
): Promise<void>

FCM からアプリケーションの登録を解除します。

パラメータ

• callback

  function 省略可

  callback パラメータは次のようになります。

  () => void

戻り値

• Promise<void>

  Chrome 116 以降

  登録解除が完了すると解決します。Promise が拒否されなければ、登録解除は成功です。

  Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

イベント

onMessage

chrome.gcm.onMessage.addListener(
  callback: function,
)

FCM を介してメッセージを受信したときに呼び出されます。

パラメータ

• callback

  関数

  callback パラメータは次のようになります。

  (message: object) => void

  • メッセージ

    オブジェクト

    • collapseKey

      文字列 省略可

      メッセージの折りたたみキー。詳しくは、折りたたみできないメッセージと折りたたみできるメッセージをご覧ください。

    • データ

      オブジェクト

      メッセージ データ。

    • from

      文字列 省略可

      メッセージを発行した送信者。

onMessagesDeleted

chrome.gcm.onMessagesDeleted.addListener(
  callback: function,
)

アプリサーバーからアプリに送信されたメッセージを FCM サーバーが削除する必要があった場合に呼び出されます。このイベントの処理の詳細については、メッセージの有効期間をご覧ください。

パラメータ

• callback

  関数

  callback パラメータは次のようになります。

  () => void

onSendError

chrome.gcm.onSendError.addListener(
  callback: function,
)

FCM サーバーにメッセージを送信できなかったときに呼び出されます。

パラメータ

• callback

  関数

  callback パラメータは次のようになります。

  (error: object) => void

  • エラー

    オブジェクト

    • 詳細

      オブジェクト

      エラーに関する追加の詳細情報（利用可能な場合）。

    • errorMessage

      文字列

      問題を説明するエラー メッセージ。

    • messageId

      文字列 省略可

      エラーが特定のメッセージに関連している場合、このエラーが発生したメッセージの ID。