chrome.instanceID

説明

chrome.instanceID を使用して Instance ID サービスにアクセスします。

権限

gcm

対象

Chrome 44 以降

メソッド

deleteID()

Promise 
chrome.instanceID.deleteID(
  callback?: function,
): Promise<void>

アプリ インスタンス識別子をリセットし、それに関連付けられているすべてのトークンを取り消します。

パラメータ

  • callback

    関数 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 96 以降

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

deleteToken()

Promise 
chrome.instanceID.deleteToken(
  deleteTokenParams: object,
  callback?: function,
): Promise<void>

付与されたトークンを取り消します。

パラメータ

  • deleteTokenParams

    オブジェクト

    deleteToken のパラメータ。

    • authorizedEntity

      文字列

      Chrome 46 以降

      トークンの取得に使用される承認済みエンティティ。

    • スコープ

      文字列

      Chrome 46 以降

      トークンの取得に使用されるスコープ。

  • callback

    関数 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 96 以降

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

getCreationTime()

Promise 
chrome.instanceID.getCreationTime(
  callback?: function,
): Promise<number>

InstanceID が生成された時刻を取得します。作成時間は callback によって返されます。

パラメータ

  • callback

    関数 省略可

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

    (creationTime: number) => void

    • creationTime

      数値

      インスタンス ID が生成された日時（エポックからのミリ秒数）。

戻り値

  • Promise<number>

    Chrome 96 以降

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

getID()

Promise 
chrome.instanceID.getID(
  callback?: function,
): Promise<string>

アプリ インスタンスの識別子を取得します。インスタンス ID は callback によって返されます。アプリケーション ID が取り消されるか期限切れにならない限り、同じ ID が返されます。

パラメータ

  • callback

    関数 省略可

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

    (instanceID: string) => void

    • instanceID

      文字列

      アプリ インスタンスに割り当てられたインスタンス ID。

戻り値

  • Promise<string>

    Chrome 96 以降

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

getToken()

Promise 
chrome.instanceID.getToken(
  getTokenParams: object,
  callback?: function,
): Promise<string>

認可されたエンティティがスコープで定義されたサービスにアクセスできるようにするトークンを返します。

パラメータ

  • getTokenParams

    オブジェクト

    getToken のパラメータ。

    • authorizedEntity

      文字列

      Chrome 46 以降

      このインスタンス ID に関連付けられたリソースへのアクセス権を持つエンティティを識別します。Google デベロッパー コンソールのプロジェクト ID を指定できます。

    • オプション

      オブジェクト 省略可

      Chrome 46 以降 Chrome 89 以降で非推奨

      オプションは非推奨であり、無視されます。

      トークンに関連付けられ、リクエストの処理で使用される可能性のある少数の文字列 Key-Value ペアを含めることができます。

    • スコープ

      文字列

      Chrome 46 以降

      認可されたエンティティが実行できる認可済みアクションを特定します。たとえば、GCM メッセージを送信する場合は、GCM スコープを使用する必要があります。

  • callback

    関数 省略可

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

    (token: string) => void

    • token

      文字列

      リクエストされたサービスによって割り当てられたトークン。

戻り値

  • Promise<string>

    Chrome 96 以降

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

イベント

onTokenRefresh

chrome.instanceID.onTokenRefresh.addListener(
  callback: function,
)

付与されたすべてのトークンを更新する必要がある場合に発生します。

パラメータ

  • callback

    関数

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

    () => void