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();
    }
  });
});

権限を追加した結果として警告メッセージが 表示して承諾しました。たとえば、前述のコードでは、次のようなプロンプトが表示されます。 これを次のように使用します。

ステップ 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,
)