chrome.management

説明

chrome.management API を使用すると、インストール済みのアプリと拡張機能を管理できます。

権限

management

マニフェスト

「management」として拡張機能のマニフェストで管理権限を使用するための権限を API例:

{
  "name": "My extension",
  ...
  "permissions": [
    "management"
  ],
  ...
}

management.getPermissionWarningsByManifest、management.uninstallSelf、 management.getSelf には管理権限は必要ありません。

型

ExtensionDisabledReason

Chrome 44 以降

アイテムが無効になっている理由。

列挙型

「不明」

"permissions_increase"

ExtensionInfo

インストールされている拡張機能、アプリ、テーマについての情報。

プロパティ

  • appLaunchUrl

    文字列（省略可）

    起動 URL（アプリの場合にのみ存在します）。

  • availableLaunchTypes

    LaunchType[] 省略可

    現在利用可能な起動タイプ（アプリの場合にのみ存在します）。

  • description

    文字列

    この拡張機能、アプリ、テーマの説明。

  • disabledReason

    ExtensionDisabledReason（省略可）

    アイテムが無効になっている理由。

  • 有効

    ブール値

    現在有効か無効か。

  • homepageUrl

    文字列（省略可）

    この拡張機能、アプリ、テーマのホームページの URL です。

  • hostPermissions

    string[]

    ホストベースの権限のリストを返します。

  • アイコン

    IconInfo[] 省略可

    アイコン情報のリスト。これはマニフェストで宣言されたものを反映しているに過ぎず、その URL の実際の画像は宣言されたものと異なる場合があります。そのため、これらの画像を参照する img タグでは、明示的な幅と高さの属性を使用することをご検討ください。詳しくは、アイコンに関するマニフェスト ドキュメントをご覧ください。

  • id

    文字列

    拡張機能の一意の識別子。

  • installType

    ExtensionInstallType

    拡張機能のインストール方法。

  • isApp

    ブール値

    <ph type="x-smartling-placeholder"></ph> 非推奨

    management.ExtensionInfo.type を使用してください。

    アプリの場合は true。

  • launchType

    LaunchType（省略可）

    アプリの起動タイプ（アプリの場合にのみ存在します）。

  • mayDisable

    ブール値

    ユーザーがこの拡張機能を無効にしたりアンインストールしたりできるかどうか。

  • mayEnable

    ブール値（省略可）

    Chrome 62 以降

    ユーザーがこの拡張機能を有効にできるかどうか。これは、有効になっていない拡張機能に対してのみ返されます。

  • name

    文字列

    この拡張機能、アプリ、テーマの名前。

  • offlineEnabled

    ブール値

    拡張機能、アプリ、テーマでオフラインのサポートが宣言されているかどうか。

  • optionsUrl

    文字列

    商品アイテムのオプション ページの URL（ある場合）。

  • 権限

    string[]

    API ベースの権限のリストを返します。

  • 略称

    文字列

    この拡張機能、アプリ、テーマの名前の短いバージョン。

  • この拡張機能、アプリ、テーマの種類。

  • updateUrl

    文字列（省略可）

    この拡張機能、アプリ、テーマの更新 URL。

  • version

    文字列

    この拡張機能、アプリ、テーマのバージョン。

  • versionName

    文字列（省略可）

    Chrome 50 以降

    この拡張機能、アプリ、テーマのバージョン名（マニフェストで指定されている場合）。

ExtensionInstallType

Chrome 44 以降

拡張機能のインストール方法。次のいずれか admin: 管理ポリシーにより拡張機能がインストールされました。 development: 拡張機能がデベロッパー モードで解凍されて読み込まれました。 normal: 拡張機能は .crx ファイルを使用して正常にインストールされた sideload: 拡張機能はマシン上の他のソフトウェアによってインストールされた other: 拡張機能は他の方法でインストールされました。

列挙型

"admin"

development"

「normal」

"sideload"

「その他」

ExtensionType

Chrome 44 以降

この拡張機能、アプリ、テーマの種類。

列挙型

「拡張機能」

"Hosted_app"

&quot;packaged_app&quot;

&quot;legacy_packaged_app&quot;

"theme"

&quot;login_screen_extension&quot;

IconInfo

拡張機能、アプリ、テーマに属するアイコンに関する情報。

プロパティ

  • サイズ

    数値

    アイコンの幅と高さを表す数値。考えられる値には、128、48、24、16 などがあります（ただし、これらに限定されません）。

  • URL

    文字列

    このアイコン画像の URL。グレースケールのアイコンを表示する（拡張機能が無効になっていることを示すなど）には、URL に ?grayscale=true を追加します。

LaunchType

これらはすべて、アプリの起動が可能なタイプです。

列挙型

&quot;OPEN_AS_REGULAR_TAB&quot;

&quot;OPEN_AS_PINNED_TAB&quot;

"OPEN_AS_WINDOW"

「OPEN_FULL_SCREEN」

UninstallOptions

Chrome 88 以降

拡張機能のアンインストールの処理方法に関するオプション。

プロパティ

  • showConfirmDialog

    ブール値（省略可）

    アンインストールの確認ダイアログでユーザーに確認を求めるかどうかを指定します。自己アンインストールの場合のデフォルトは false です。拡張機能によって別の拡張機能がアンインストールされた場合、このパラメータは無視され、ダイアログは常に表示されます。

メソッド

createAppShortcut()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.management.createAppShortcut(
  id: string,
  callback?: function,
)

アプリのショートカットを作成するためのオプションを表示します。Mac では、パッケージ化アプリのショートカットのみを作成できます。

パラメータ

  • id

    文字列

    management.ExtensionInfo のアプリアイテムの ID である必要があります。

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 88 以降

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

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.management.generateAppForLink(
  url: string,
  title: string,
  callback?: function,
)

URL のアプリを生成します。生成されたブックマーク アプリを返します。

パラメータ

  • URL

    文字列

    ウェブページの URL。URL のスキームは「http」のみですアクセスします。

  • title

    文字列

    生成されたアプリのタイトル。

  • callback

    関数（省略可）

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

    (result: ExtensionInfo) => void

戻り値

  • Promise&lt;ExtensionInfo&gt;

    Chrome 88 以降

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

get()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.management.get(
  id: string,
  callback?: function,
)

指定された ID を持つインストール済みの拡張機能、アプリ、テーマに関する情報を返します。

パラメータ

戻り値

  • Promise&lt;ExtensionInfo&gt;

    Chrome 88 以降

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

getAll()

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

インストールされている拡張機能とアプリに関する情報のリストを返します。

パラメータ

  • callback

    関数（省略可）

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

    (result: ExtensionInfo[]) => void

戻り値

  • Promise&lt;ExtensionInfo[]&gt;

    Chrome 88 以降

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

getPermissionWarningsById()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.management.getPermissionWarningsById(
  id: string,
  callback?: function,
)

指定された拡張機能 ID に関する権限警告のリストを返します。

パラメータ

  • id

    文字列

    すでにインストールされている拡張機能の ID。

  • callback

    関数（省略可）

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

    (permissionWarnings: string[]) => void

    • permissionWarnings

      string[]

戻り値

  • Promise&lt;string[]&gt;

    Chrome 88 以降

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

getPermissionWarningsByManifest()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.management.getPermissionWarningsByManifest(
  manifestStr: string,
  callback?: function,
)

指定された拡張機能のマニフェスト文字列に関する権限に関する警告のリストを返します。注: この関数は、「management」権限を宣言する必要があります。

パラメータ

  • manifestStr

    文字列

    拡張機能マニフェストの JSON 文字列。

  • callback

    関数（省略可）

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

    (permissionWarnings: string[]) => void

    • permissionWarnings

      string[]

戻り値

  • Promise&lt;string[]&gt;

    Chrome 88 以降

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

getSelf()

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

呼び出し元の拡張機能、アプリ、テーマに関する情報を返します。注: この関数は、「management」権限を宣言する必要があります。

パラメータ

  • callback

    関数（省略可）

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

    (result: ExtensionInfo) => void

戻り値

  • Promise&lt;ExtensionInfo&gt;

    Chrome 88 以降

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

installReplacementWebApp()

<ph type="x-smartling-placeholder"></ph> 約束 Chrome 77 以降 をご覧ください。
chrome.management.installReplacementWebApp(
  callback?: function,
)

マニフェストで指定された replacement_web_app を起動します。まだインストールされていない場合、ユーザーにインストールを求めます。

パラメータ

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 88 以降

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

launchApp()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.management.launchApp(
  id: string,
  callback?: function,
)

アプリケーションを起動します。

パラメータ

  • id

    文字列

    アプリケーションの拡張機能 ID。

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 88 以降

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

setEnabled()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.management.setEnabled(
  id: string,
  enabled: boolean,
  callback?: function,
)

アプリや拡張機能を有効または無効にできます。ほとんどの場合、この関数はユーザー操作のコンテキスト（ボタンのクリック ハンドラなど）で呼び出す必要があります。また、不正使用を防ぐために、ネイティブの確認 UI をユーザーに表示することもできます。

パラメータ

  • id

    文字列

    management.ExtensionInfo のアイテムの ID にする必要があります。

  • 有効

    ブール値

    このアイテムを有効にするかどうかを指定します。

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 88 以降

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

setLaunchType()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.management.setLaunchType(
  id: string,
  launchType: LaunchType,
  callback?: function,
)

アプリの起動タイプを設定します。

パラメータ

  • id

    文字列

    management.ExtensionInfo のアプリアイテムの ID である必要があります。

  • launchType

    LaunchType

    ターゲットの起動タイプ。利用可能な起動タイプはプラットフォームや構成によって異なるため、この起動タイプが ExtensionInfo.availableLaunchTypes になっていることを必ず確認してください。

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 88 以降

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

uninstall()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.management.uninstall(
  id: string,
  options?: UninstallOptions,
  callback?: function,
)

現在インストールされているアプリまたは拡張機能をアンインストールします。注: この機能は、ユーザーが指定した拡張機能またはアプリをアンインストールできない管理対象環境では機能しません。アンインストールが失敗した場合（ユーザーがダイアログをキャンセルした場合など）は、Promise が拒否されるか、runtime.lastError を設定してコールバックが呼び出されます。

パラメータ

  • id

    文字列

    management.ExtensionInfo のアイテムの ID にする必要があります。

  • オプション

    UninstallOptions（省略可）

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 88 以降

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

uninstallSelf()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.management.uninstallSelf(
  options?: UninstallOptions,
  callback?: function,
)

通話拡張機能をアンインストールします。注: この関数は、「management」権限を宣言する必要があります。ユーザーが指定の拡張機能またはアプリをアンインストールできない場合、この機能は管理対象環境では機能しません。

パラメータ

  • オプション

    UninstallOptions（省略可）

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 88 以降

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

イベント

onDisabled

chrome.management.onDisabled.addListener(
  callback: function,
)

アプリまたは拡張機能が無効になると呼び出されます。

パラメータ

onEnabled

chrome.management.onEnabled.addListener(
  callback: function,
)

アプリや拡張機能が有効になると呼び出されます。

パラメータ

onInstalled

chrome.management.onInstalled.addListener(
  callback: function,
)

アプリまたは拡張機能がインストールされたときに呼び出されます。

パラメータ

onUninstalled

chrome.management.onUninstalled.addListener(
  callback: function,
)

アプリまたは拡張機能がアンインストールされたときに呼び出されます。

パラメータ

  • callback

    関数

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

    (id: string) => void

    • id

      文字列