chrome.management

説明

chrome.management API は、インストールされたアプリと拡張機能を管理する方法を提供します。

権限

management

管理 API を使用するには、拡張機能のマニフェストで「management」権限を宣言する必要があります。次に例を示します。

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

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

型

ExtensionDisabledReason

Chrome 44 以降

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

列挙型

"unknown"

"permissions_increase"

ExtensionInfo

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

プロパティ

  • appLaunchUrl

    文字列 省略可

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

  • availableLaunchTypes

    LaunchType[] 省略可

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

  • 説明

    文字列

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

  • disabledReason

    ExtensionDisabledReason 省略可

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

  • 有効

    ブール値

    現在有効か無効か。

  • homepageUrl

    文字列 省略可

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

  • hostPermissions

    string[]

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

  • アイコン

    IconInfo[] 省略可

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

  • id

    文字列

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

  • installType

    ExtensionInstallType

    拡張機能がインストールされた方法。

  • isApp

    ブール値

    非推奨

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

    アプリの場合は true。

  • launchType

    LaunchType 省略可

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

  • mayDisable

    ブール値

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

  • mayEnable

    ブール値（省略可）

    Chrome 62 以降

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

  • name

    文字列

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

  • offlineEnabled

    ブール値

    拡張機能、アプリ、テーマがオフラインをサポートしていることを宣言しているかどうか。

  • optionsUrl

    文字列

    アイテムのオプション ページの URL（存在する場合）。

  • 権限

    string[]

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

  • shortName

    文字列

    この拡張機能、アプリ、またはテーマの短い名前。

  • この拡張機能、アプリ、テーマのタイプ。

  • updateUrl

    文字列 省略可

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

  • version

    文字列

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

  • versionName

    文字列 省略可

    Chrome 50 以降

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

ExtensionInstallType

Chrome 44 以降

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

列挙型

"admin"

"development"

"normal"

「sideload」

"other"

ExtensionType

Chrome 44 以降

この拡張機能、アプリ、テーマのタイプ。

列挙型

"extension"

"hosted_app"

"packaged_app"

"legacy_packaged_app"

"theme"

"login_screen_extension"

IconInfo

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

プロパティ

  • サイズ

    数値

    アイコンの幅と高さを表す数値。想定される値には、128、48、24、16 などがあります。

  • URL

    文字列

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

LaunchType

アプリの起動タイプはすべて次のとおりです。

列挙型

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_AS_WINDOW"

"OPEN_FULL_SCREEN"

UninstallOptions

Chrome 88 以降

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

プロパティ

  • showConfirmDialog

    ブール値（省略可）

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

メソッド

createAppShortcut()

chrome.management.createAppShortcut(
  id: string,
): Promise<void>

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

パラメータ

戻り値

  • Promise<void>

    Chrome 88 以降 
chrome.management.generateAppForLink(
  url: string,
  title: string,
): Promise<ExtensionInfo>

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

パラメータ

  • URL

    文字列

    ウェブページの URL。URL のスキームは「http」または「https」のみです。

  • title

    文字列

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

戻り値

get()

chrome.management.get(
  id: string,
): Promise<ExtensionInfo>

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

パラメータ

戻り値

getAll()

chrome.management.getAll(): Promise<ExtensionInfo[]>

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

戻り値

getPermissionWarningsById()

chrome.management.getPermissionWarningsById(
  id: string,
): Promise<string[]>

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

パラメータ

  • id

    文字列

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

戻り値

  • Promise<string[]>

    Chrome 88 以降

getPermissionWarningsByManifest()

chrome.management.getPermissionWarningsByManifest(
  manifestStr: string,
): Promise<string[]>

指定された拡張機能マニフェスト文字列の権限に関する警告のリストを返します。注: この関数は、マニフェストで「管理」権限をリクエストしなくても使用できます。

パラメータ

  • manifestStr

    文字列

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

戻り値

  • Promise<string[]>

    Chrome 88 以降

getSelf()

chrome.management.getSelf(): Promise<ExtensionInfo>

呼び出し元の拡張機能、アプリ、テーマに関する情報を返します。注: この関数は、マニフェストで「管理」権限をリクエストしなくても使用できます。

戻り値

installReplacementWebApp()

Chrome 77 以降 
chrome.management.installReplacementWebApp(): Promise<void>

マニフェストで指定された replacement_web_app を起動します。まだインストールされていない場合は、インストールを求めるメッセージが表示されます。

戻り値

  • Promise<void>

    Chrome 88 以降

launchApp()

chrome.management.launchApp(
  id: string,
): Promise<void>

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

パラメータ

  • id

    文字列

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

戻り値

  • Promise<void>

    Chrome 88 以降

setEnabled()

chrome.management.setEnabled(
  id: string,
  enabled: boolean,
): Promise<void>

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

パラメータ

  • id

    文字列

    これは management.ExtensionInfo のアイテムの ID である必要があります。

  • 有効

    ブール値

    このアイテムを有効にするか無効にするか。

戻り値

  • Promise<void>

    Chrome 88 以降

setLaunchType()

chrome.management.setLaunchType(
  id: string,
  launchType: LaunchType,
): Promise<void>

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

パラメータ

  • id

    文字列

    これは、management.ExtensionInfo のアプリアイテムの ID にする必要があります。

  • launchType

    LaunchType

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

戻り値

  • Promise<void>

    Chrome 88 以降

uninstall()

chrome.management.uninstall(
  id: string,
  options?: UninstallOptions,
): Promise<void>

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

パラメータ

戻り値

  • Promise<void>

    Chrome 88 以降

uninstallSelf()

chrome.management.uninstallSelf(
  options?: UninstallOptions,
): Promise<void>

通話拡張機能をアンインストールします。注: この関数は、マニフェストで「管理」権限をリクエストしなくても使用できます。この関数は、ユーザーが指定された拡張機能やアプリをアンインストールできない管理対象環境では機能しません。

パラメータ

戻り値

  • Promise<void>

    Chrome 88 以降

イベント

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

      文字列