chrome.gcm

説明

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

権限

gcm

プロパティ

MAX_MESSAGE_SIZE

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

値

4096

Methods

register()

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

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

パラメータ

  • senderIds

    string[]

    アプリケーションへのメッセージの送信が許可されるサーバー ID のリスト。含まれている送信者 ID は 1 ～ 100 個です。

  • callback

    関数（省略可）

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

    (registrationId: string)=>void

    • registrationId

      文字列

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

戻り値

  • Promise<文字列>

    Chrome 116 以降

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

send()

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

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

パラメータ

  • message

    オブジェクト

    FCM 経由で相手側に送信するメッセージ。

    • data

      オブジェクト

      サーバーに送信するメッセージ データ。大文字と小文字を区別しない 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

    関数（省略可）

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

    (messageId: string)=>void

    • messageId

      文字列

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

戻り値

  • Promise<文字列>

    Chrome 116 以降

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

unregister()

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

FCM からアプリの登録を解除します。

パラメータ

  • callback

    関数（省略可）

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

    ()=>void

戻り値

  • Promise<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

    • error

      オブジェクト

      • 詳細

        オブジェクト

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

      • errorMessage

        文字列

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

      • messageId

        string（省略可）

        このエラーが含まれるメッセージの ID（エラーが特定のメッセージに関連している場合）。