chrome.instanceID

説明

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

権限

gcm

対象

Chrome 44 以降

メソッド

deleteID()

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

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

パラメータ

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

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

deleteToken()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.instanceID.deleteToken(
  deleteTokenParams: object,
  callback?: function,
)

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

パラメータ

  • deleteTokenParams

    オブジェクト

    deleteToken のパラメータ。

    • authorizedEntity

      文字列

      Chrome 46 以降

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

    • スコープ

      文字列

      Chrome 46 以降

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

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

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

getCreationTime()

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

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

パラメータ

  • callback

    関数（省略可）

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

    (creationTime: number) => void

    • creationTime

      数値

      インスタンス ID が生成され、エポックからのミリ秒単位の経過時間。

戻り値

  • Promise&lt;number&gt;

    Chrome 96 以降

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

getID()

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

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

パラメータ

  • callback

    関数（省略可）

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

    (instanceID: string) => void

    • instanceID

      文字列

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

戻り値

  • Promise<文字列>

    Chrome 96 以降

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

getToken()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.instanceID.getToken(
  getTokenParams: object,
  callback?: function,
)

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

パラメータ

  • getTokenParams

    オブジェクト

    getToken のパラメータ。

    • authorizedEntity

      文字列

      Chrome 46 以降

      このインスタンス ID に関連付けられたリソースへのアクセスが許可されているエンティティを識別します。Google Developer Console のプロジェクト ID を指定できます。

    • オプション

      オブジェクト（省略可）

      Chrome 46 以降 Chrome 89 以降非推奨

      オプションが非推奨になっており、無視されます。

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

    • スコープ

      文字列

      Chrome 46 以降

      承認済みエンティティが実行できる承認済みアクションを指定します。例:GCM メッセージを送信するには、GCM スコープを使用する必要があります。

  • callback

    関数（省略可）

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

    (token: string) => void

    • token

      文字列

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

戻り値

  • Promise<文字列>

    Chrome 96 以降

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

イベント

onTokenRefresh

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

付与されたすべてのトークンを更新する必要があるときに呼び出されます。

パラメータ

  • callback

    関数

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

    () => void