説明
chrome.management
API は、インストールされ実行中の拡張機能やアプリのリストを管理するための機能を提供します。これは、組み込みの新しいタブページをオーバーライドする拡張機能に特に便利です。
権限
management
管理 API を使用するには、拡張機能のマニフェストで「管理」権限を宣言する必要があります。次に例を示します。
{
"name": "My extension",
...
"permissions": [
"management"
],
...
}
management.getPermissionWarningsByManifest()
、management.uninstallSelf()
、management.getSelf()
には管理権限は必要ありません。
型
ExtensionDisabledReason
アイテムが無効になっている理由。
Enum
ExtensionInfo
インストールされている拡張機能、アプリ、テーマに関する情報。
プロパティ
-
appLaunchUrl
string(省略可)
起動 URL(アプリの場合のみ表示)。
-
availableLaunchTypes
LaunchType[] 省略可
現在利用可能な起動タイプ(アプリの場合のみ表示)。
-
description
文字列
この拡張機能、アプリ、またはテーマの説明。
-
disabledReason
アイテムが無効になっている理由。
-
有効
boolean
現在有効か無効か。
-
homepageUrl
string(省略可)
この拡張機能、アプリ、テーマのホームページの URL。
-
hostPermissions
string[]
ホストベースの権限のリストを返します。
-
アイコン
IconInfo[] 省略可
アイコン情報のリスト。これはマニフェストで宣言された内容を反映しているだけです。その URL の実際の画像は、宣言された画像よりも大きい場合もあれば、小さい場合もあります。そのため、これらの画像を参照する img タグに明示的な幅と高さの属性を使用することをおすすめします。詳しくは、アイコンに関するマニフェスト ドキュメントをご覧ください。
-
id
文字列
拡張機能の一意の識別子。
-
installType
拡張機能がインストールされた方法。
-
isApp
boolean
非推奨management.ExtensionInfo.type
を使用してください。アプリの場合は true に設定します。
-
launchType
LaunchType 省略可
アプリの起動タイプ(アプリの場合のみ表示)。
-
mayDisable
boolean
ユーザーがこの拡張機能を無効にできるかどうか、またはアンインストールできるかどうか。
-
mayEnable
ブール値(省略可)
Chrome 62 以降ユーザーがこの拡張機能を有効にできるかどうか。有効になっていない拡張機能の場合にのみ返されます。
-
name
文字列
この拡張機能、アプリ、またはテーマの名前。
-
offlineEnabled
boolean
拡張機能、アプリ、テーマでオフラインのサポートが宣言されているかどうか。
-
optionsUrl
文字列
アイテムのオプション ページの URL(存在する場合)。
-
権限
string[]
API ベースの権限のリストを返します。
-
shortName
文字列
この拡張機能、アプリ、テーマの短いバージョンです。
-
タイプ
この拡張機能、アプリ、テーマのタイプ。
-
updateUrl
string(省略可)
この拡張機能、アプリ、テーマの更新 URL。
-
バージョン
文字列
この拡張機能、アプリ、テーマのバージョン。
-
versionName
string(省略可)
Chrome 50 以降この拡張機能、アプリ、テーマのバージョン名(マニフェストで指定されている場合)。
ExtensionInstallType
拡張機能がインストールされた方法。次のいずれか:
admin
: 管理ポリシーにより拡張機能がインストールされました。
development
: 拡張機能はデベロッパー モードで展開されて読み込まれました。
normal
: 拡張機能は .crx ファイルを介して正常にインストールされました。
sideload
: 拡張機能はマシン上の他のソフトウェアによってインストールされました。
other
: 拡張機能は別の方法でインストールされました。
Enum
"admin"
"development"
"normal"
ExtensionType
この拡張機能、アプリ、テーマのタイプ。
Enum
"extension"
"login_screen_extension"
IconInfo
拡張機能、アプリ、テーマに属するアイコンに関する情報。
プロパティ
-
サイズ
数値
アイコンの幅と高さを表す数値。考えられる値には、128、48、24、16 などがありますが、これらに限定されません。
-
URL
文字列
このアイコン画像の URL。アイコンをグレースケール バージョンに表示するには(拡張機能が無効になっていることを示すためなど)には、URL に
?grayscale=true
を追加します。
LaunchType
これらはすべて、可能性のあるアプリの起動タイプです。
Enum
UninstallOptions
拡張機能のアンインストールを処理する方法に関するオプション。
プロパティ
-
showConfirmDialog
ブール値(省略可)
アンインストールの確認ダイアログでユーザーにプロンプトを表示するかどうかを指定します。自己アンインストールのデフォルトは false です。拡張機能が別の拡張機能をアンインストールする場合、このパラメータは無視され、常にダイアログが表示されます。
Methods
createAppShortcut()
chrome.management.createAppShortcut(
id: string,
callback?: function,
)
アプリのショートカットを作成するための表示オプション。Mac では、パッケージ化アプリのショートカットのみを作成できます。
パラメータ
-
id
文字列
management.ExtensionInfo
のアプリ アイテムの ID を指定する必要があります。 -
callback
関数(省略可)
callback
パラメータは次のようになります。() => void
戻り値
-
Promise<void>
Chrome 88 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
generateAppForLink()
chrome.management.generateAppForLink(
url: string,
title: string,
callback?: function,
)
URL のアプリを生成します。生成されたブックマーク アプリを返します。
パラメータ
-
URL
文字列
ウェブページの URL。URL のスキームは「http」または「https」のみです。
-
title
文字列
生成されたアプリのタイトル。
-
callback
関数(省略可)
callback
パラメータは次のようになります。(result: ExtensionInfo) => void
-
件の結果
-
戻り値
-
Promise<ExtensionInfo>
Chrome 88 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
get()
chrome.management.get(
id: string,
callback?: function,
)
指定された ID を持つインストール済みの拡張機能、アプリ、テーマに関する情報を返します。
パラメータ
-
id
文字列
management.ExtensionInfo
のアイテムの ID。 -
callback
関数(省略可)
callback
パラメータは次のようになります。(result: ExtensionInfo) => void
-
件の結果
-
戻り値
-
Promise<ExtensionInfo>
Chrome 88 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
getAll()
chrome.management.getAll(
callback?: function,
)
インストールされている拡張機能とアプリに関する情報のリストを返します。
パラメータ
-
callback
関数(省略可)
callback
パラメータは次のようになります。(result: ExtensionInfo[]) => void
-
件の結果
-
戻り値
-
Promise<ExtensionInfo[]>
Chrome 88 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
getPermissionWarningsById()
chrome.management.getPermissionWarningsById(
id: string,
callback?: function,
)
指定された拡張機能 ID の権限に関する警告のリストを返します。
パラメータ
-
id
文字列
すでにインストールされている拡張機能の ID。
-
callback
関数(省略可)
callback
パラメータは次のようになります。(permissionWarnings: string[]) => void
-
permissionWarnings
string[]
-
戻り値
-
Promise<string[]>
Chrome 88 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
getPermissionWarningsByManifest()
chrome.management.getPermissionWarningsByManifest(
manifestStr: string,
callback?: function,
)
指定された拡張機能のマニフェスト文字列に関する権限に関する警告のリストを返します。注: この関数は、マニフェストで「管理」権限をリクエストしなくても使用できます。
パラメータ
-
manifestStr
文字列
拡張機能のマニフェストの JSON 文字列。
-
callback
関数(省略可)
callback
パラメータは次のようになります。(permissionWarnings: string[]) => void
-
permissionWarnings
string[]
-
戻り値
-
Promise<string[]>
Chrome 88 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
getSelf()
chrome.management.getSelf(
callback?: function,
)
電話番号表示オプション、アプリ、テーマに関する情報を返します。注: この関数は、マニフェストで「管理」権限をリクエストしなくても使用できます。
パラメータ
-
callback
関数(省略可)
callback
パラメータは次のようになります。(result: ExtensionInfo) => void
-
件の結果
-
戻り値
-
Promise<ExtensionInfo>
Chrome 88 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
installReplacementWebApp()
chrome.management.installReplacementWebApp(
callback?: function,
)
マニフェストで指定された代替ウェブアプリを起動します。まだインストールしていない場合は、インストールするようユーザーに促します。
パラメータ
-
callback
関数(省略可)
callback
パラメータは次のようになります。() => void
戻り値
-
Promise<void>
Chrome 88 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
launchApp()
chrome.management.launchApp(
id: string,
callback?: function,
)
アプリケーションを起動する。
パラメータ
-
id
文字列
アプリケーションの拡張機能 ID。
-
callback
関数(省略可)
callback
パラメータは次のようになります。() => void
戻り値
-
Promise<void>
Chrome 88 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
setEnabled()
chrome.management.setEnabled(
id: string,
enabled: boolean,
callback?: function,
)
アプリや拡張機能を有効または無効にします。ほとんどの場合、この関数はユーザー操作のコンテキスト(ボタンの click ハンドラなど)の中で呼び出す必要があり、不正使用を防ぐためにネイティブの確認 UI をユーザーに表示できます。
パラメータ
-
id
文字列
management.ExtensionInfo
のアイテムの ID を指定する必要があります。 -
有効
boolean
このアイテムを有効にするか無効にするか。
-
callback
関数(省略可)
callback
パラメータは次のようになります。() => void
戻り値
-
Promise<void>
Chrome 88 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
setLaunchType()
chrome.management.setLaunchType(
id: string,
launchType: LaunchType,
callback?: function,
)
アプリの起動タイプを設定します。
パラメータ
-
id
文字列
management.ExtensionInfo
のアプリ アイテムの ID を指定する必要があります。 -
launchType
ターゲットの起動タイプ。利用可能なリリースの種類はプラットフォームや設定によって異なるため、このリリース タイプが
ExtensionInfo.availableLaunchTypes
に含まれているかを必ずご確認ください。 -
callback
関数(省略可)
callback
パラメータは次のようになります。() => void
戻り値
-
Promise<void>
Chrome 88 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
uninstall()
chrome.management.uninstall(
id: string,
options?: UninstallOptions,
callback?: function,
)
現在インストールされているアプリまたは拡張機能をアンインストールします。注: この関数は、指定した拡張機能やアプリのアンインストールがユーザーに許可されていない場合、マネージド環境では機能しません。アンインストールが失敗した場合は(ユーザーがダイアログをキャンセルした場合など)、Promise が拒否されるか、コールバックが runtime.lastError
が設定された状態で呼び出されます。
パラメータ
-
id
文字列
management.ExtensionInfo
のアイテムの ID を指定する必要があります。 -
オプション
UninstallOptions 省略可
-
callback
関数(省略可)
callback
パラメータは次のようになります。() => void
戻り値
-
Promise<void>
Chrome 88 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
uninstallSelf()
chrome.management.uninstallSelf(
options?: UninstallOptions,
callback?: function,
)
電話番号表示オプションをアンインストールします。注: この関数は、マニフェストで「管理」権限をリクエストしなくても使用できます。この関数は、指定した拡張機能やアプリのアンインストールをユーザーに許可されていない管理対象環境では動作しません。
パラメータ
-
オプション
UninstallOptions 省略可
-
callback
関数(省略可)
callback
パラメータは次のようになります。() => void
戻り値
-
Promise<void>
Chrome 88 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
イベント
onDisabled
chrome.management.onDisabled.addListener(
callback: function,
)
アプリまたは拡張機能が無効になると呼び出されます。
パラメータ
-
callback
機能
callback
パラメータは次のようになります。(info: ExtensionInfo) => void
onEnabled
chrome.management.onEnabled.addListener(
callback: function,
)
アプリや拡張機能が有効になると呼び出されます。
パラメータ
-
callback
機能
callback
パラメータは次のようになります。(info: ExtensionInfo) => void
onInstalled
chrome.management.onInstalled.addListener(
callback: function,
)
アプリや拡張機能がインストールされたときに呼び出されます。
パラメータ
-
callback
機能
callback
パラメータは次のようになります。(info: ExtensionInfo) => void
onUninstalled
chrome.management.onUninstalled.addListener(
callback: function,
)
アプリまたは拡張機能がアンインストールされると呼び出されます。
パラメータ
-
callback
機能
callback
パラメータは次のようになります。(id: string) => void
-
id
文字列
-