chrome.gcm

説明

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

権限

gcm

プロパティ

MAX_MESSAGE_SIZE

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

値

4096

メソッド

register()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
)

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

パラメータ

  • senderIds

    string[]

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

  • callback

    関数（省略可）

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

    (registrationId: string) => void

    • registrationId

      文字列

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

戻り値

  • Promise<文字列>

    Chrome 116 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

send()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.gcm.send(
  message: object,
  callback?: function,
)

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

パラメータ

  • メッセージ

    オブジェクト

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

    • データ

      オブジェクト

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

    • destinationId

      文字列

      Google API Console によって割り当てられた、メッセージの送信先となるサーバーの ID。

    • messageId

      文字列

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

    • timeToLive

      数値（省略可）

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

  • callback

    関数（省略可）

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

    (messageId: string) => void

    • messageId

      文字列

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

戻り値

  • Promise<文字列>

    Chrome 116 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

unregister()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.gcm.unregister(
  callback?: function,
)

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

パラメータ

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 116 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

イベント

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。