chrome.permissions

説明

コンセプトと使用方法

権限に関する警告は、API によって付与される機能を説明するものですが、わかりにくい場合もあります。Permissions API を使用することで、デベロッパーは権限に関する警告について説明し、新しい機能を段階的に導入できるため、ユーザーはリスクなく拡張機能を体験できます。このようにして、ユーザーは付与するアクセス権の範囲と有効にする機能を指定できます。

たとえば、オプションの権限拡張機能のコア機能は新しいタブページをオーバーライドします。一つは、その日のユーザーの目標を表示する機能です。この機能に必要なのは storage 権限のみです（警告は表示されません）。この拡張機能には追加機能があり、ユーザーは次のボタンをクリックして有効にできます。

ユーザーの上位のサイトを表示するには topSites 権限が必要です。この場合、次の警告が表示されます。

オプションの権限を実装する

ステップ 1: 必要な権限とオプションの権限を決定する

拡張機能では、必要な権限と省略可能な権限の両方を宣言できます。一般に、次のことを行う必要があります。

• 拡張機能の基本機能に必要な場合は、必要な権限を使用します。
• 拡張機能のオプション機能に必要な場合は、オプションの権限を使用します。

必要な権限のメリット:

• プロンプトの表示数を減らす: 拡張機能では、ユーザーにすべての権限の承認を求めるメッセージが 1 回表示されます。
• 開発の簡素化: 必要な権限が確実に存在する。

オプションの権限のメリット:

• セキュリティの強化: ユーザーは必要な権限のみを有効にするため、より少ない権限で拡張機能が実行されます。
• ユーザーにとって有益な情報: ユーザーが関連機能を有効化する際に、特定の権限が必要な理由を拡張機能に説明できます。
• アップグレードが簡単: 拡張機能をアップグレードしたときに、必要な権限ではなくオプションの権限が追加されても、ユーザーに対して拡張機能が無効になることはありません。

ステップ 2: マニフェストでオプションの権限を宣言する

拡張機能のマニフェストで、optional_permissions キーを使用して、permissions フィールドと同じ形式を使用してオプションの権限を宣言します。

{
  "name": "My extension",
  ...
  "optional_permissions": ["tabs"],
  "optional_host_permissions": ["https://www.google.com/"],
  ...
}

実行時にのみ検出されるホストをリクエストする場合は、拡張機能の optional_host_permissions フィールドに "https://*/*" を含めます。これにより、一致するスキームがある限り、"Permissions.origins" で任意のオリジンを指定できます。

オプションとして指定できない権限

ほとんどの Chrome 拡張機能の権限はオプションとして指定できますが、以下の例外があります。

使用可能な権限とその警告について詳しくは、権限を宣言するをご覧ください。

ステップ 3: オプションの権限をリクエストする

permissions.request() を使用して、ユーザー操作内から権限をリクエストします。

document.querySelector('#my-button').addEventListener('click', (event) => {
  // Permissions must be requested from inside a user gesture, like a button's
  // click handler.
  chrome.permissions.request({
    permissions: ['tabs'],
    origins: ['https://www.google.com/']
  }, (granted) => {
    // The callback argument will be true if the user granted the permissions.
    if (granted) {
      doSomething();
    } else {
      doSomethingElse();
    }
  });
});

Chrome は、権限を追加すると、ユーザーが表示して承諾したメッセージとは異なる警告メッセージがユーザーに表示される場合、ユーザーに確認します。たとえば、上記のコードでは、次のようなプロンプトが返されます。

ステップ 4: 拡張機能の現在の権限を確認する

拡張機能に特定の権限または権限セットがあるかどうかを確認するには、permission.contains() を使用します。

chrome.permissions.contains({
  permissions: ['tabs'],
  origins: ['https://www.google.com/']
}, (result) => {
  if (result) {
    // The extension has the permissions.
  } else {
    // The extension doesn't have the permissions.
  }
});

ステップ 5: 権限を削除する

不要になった権限は削除してください。権限の削除後に permissions.request() を呼び出すと、通常はユーザーに確認を求めることなく権限が追加されます。

chrome.permissions.remove({
  permissions: ['tabs'],
  origins: ['https://www.google.com/']
}, (removed) => {
  if (removed) {
    // The permissions have been removed.
  } else {
    // The permissions have not been removed (e.g., you tried to remove
    // required permissions).
  }
});

chrome.permissions.contains(
  permissions: Permissions,
  callback?: function,
)

chrome.permissions.getAll(
  callback?: function,
)

chrome.permissions.remove(
  permissions: Permissions,
  callback?: function,
)

chrome.permissions.request(
  permissions: Permissions,
  callback?: function,
)

chrome.permissions.onAdded.addListener(
  callback: function,
)

chrome.permissions.onRemoved.addListener(
  callback: function,
)