chrome.gcm

説明

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

権限

gcm

プロパティ

MAX_MESSAGE_SIZE

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

値

4096

メソッド

register()

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

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

パラメータ

  • senderIds

    string[]

    アプリケーションにメッセージを送信することを許可されたサーバー ID のリスト。送信者 ID を 1 つ以上 100 個以下含める必要があります。

戻り値

  • Promise<string>

    Chrome 116 以降

send()

chrome.gcm.send(
  message: object,
): 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 の場合、メッセージは直ちに送信されるか、送信できない場合は失敗します。存続時間（TTL）のデフォルト値は 86,400 秒（1 日）で、最大値は 2,419,200 秒（28 日）です。

戻り値

  • Promise<string>

    Chrome 116 以降

unregister()

chrome.gcm.unregister(): Promise<void>

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

戻り値

  • Promise<void>

    Chrome 116 以降

イベント

onMessage

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

FCM を介してメッセージを受信したときに発生します。

パラメータ

  • callback

    関数

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

    (message: object) => void

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。