chrome.permissions

説明

概要

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

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

ユーザーのトップサイトを表示するには、topSites 権限が必要です。この権限には次の警告が適用されます。

任意の権限を実装する

ステップ 1: 必要な権限と省略可能な権限を決定する

拡張機能では、必須権限と省略可権限の両方を宣言できます。一般的には、次のように指定します。

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

必須権限のメリット:

• プロンプトの減少: 拡張機能は、すべての権限を承認するようユーザーに 1 回だけプロンプトを表示できます。
• 開発がシンプルになる: 必要な権限が確実に存在します。

省略可の権限のメリット:

• セキュリティの強化: ユーザーが必要な権限のみを有効にするため、拡張機能はより少ない権限で実行されます。
• ユーザーへの情報の改善: ユーザーが関連する機能を有効にしたときに、拡張機能が特定の権限を必要とする理由を説明できます。
• アップグレードが容易: 拡張機能をアップグレードする際に、アップグレードで必須ではなく省略可能な権限が追加された場合、Chrome はユーザーに対して拡張機能を無効にしません。

ステップ 2: マニフェストで省略可能な権限を宣言する

オプションの権限は、permissions フィールドと同じ形式で、optional_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.addSiteAccessRequest(
  request: object,
  callback?: function,
)

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

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

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

chrome.permissions.removeSiteAccessRequest(
  request: object,
  callback?: function,
)

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

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

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