cookies

拡張機能に cookie の取得と設定と、変更された時の通知を可能にします。

この API を使用するには、manifest.json ファイルで "cookies" の API パーミッション があることと、同様にアクセスする cookie を持つ host パーミッション も必要になります。cookie パーミッションを見てください。

cookies.Cookie

HTTP cookie の情報を表す。

cookies.CookieStore

ブラウザーの cookie store を表す。

cookies.OnChangedCause

cookie の変更理由を表す。

メソッド

cookies.get()

1 つの cookie の情報を取得する。

cookies.getAll()

与えられたフィルターにマッチするすべての cookies を取得する。

cookies.set()

与えられた cookie データ を cookie に設定する; おなじ cookies が存在すれば上書きする。

cookies.remove()

指定した名前の cookie を削除する。

cookies.getAllCookieStores()

すべての cookie stores を一覧する。

イベントハンドラー

cookies.onChanged

cookie が設定、削除された時に発火する。

パーミッション

この API を使うには、アドオンは manifest で "cookies" の API パーミッション を指定せねばならず、同様に cookie がアクセスするあらゆるサイトの host パーミッションも要ります。アドオンは host パーミッションにマッチする URL から読み書きされる cookie を読み書きできます。例えば:

http://*.example.com/

この host パーミッションを持つアドオンは下記ができます:

  • www.example.com のあらゆるパスの、非セキュア型 cookie を読む
  • セキュア/非セキュア問わず、www.example.com のあらゆるパスの cookie に書き込む

下記はできません:

  • www.example.com のセキュア型 cookie を読む
http://www.example.com/

この host パーミッションを持つアドオンは下記ができます:

  • www.example.com のあらゆるパスの、非セキュア型 cookie を読む
  • .example.comのあらゆるパスの、非セキュア型 cookie を読む
  • セキュア/非セキュア問わず、www.example.comのあらゆるパスの cookie に書き込む
  • セキュア/非セキュア問わず、.example.comのあらゆるパスの cookie に書き込む

下記はできません:

  • foo.example.com の cookie の読み書き
  • foo.www.example.com の cookie の読み書き
*://*.example.com/

この host パーミッションを持つアドオンは下記ができます:

  • セキュア/非セキュア問わず、www.example.com のあらゆるパスの cookie の読み書き

ブラウザーの互換性

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
Cookie
Cookie.firstPartyDomain
Cookie.partitionKey
Cookie.sameSite
CookieStore
CookieStore.id
CookieStore.incognito
CookieStore.tabIds
OnChangedCause
get
get.firstPartyDomain
get.partitionKey
getAll
getAll.firstPartyDomain
getAll.partitionKey
getAllCookieStores
onChanged
onChanged.partitionKey
remove
remove.firstPartyDomain
remove.partitionKey
sameSiteStatus
sameSiteStatus.lax
sameSiteStatus.no_restriction
sameSiteStatus.strict
sameSiteStatus.unspecified
set
set.firstPartyDomain
set.partitionKey
set.sameSite

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
Partial support
Partial support
No support
No support
See implementation notes.
Has more compatibility info.

Example extensions

メモ: この API は Chromium の chrome.cookies API に基づいています。また、このドキュメントは cookies.json における Chromium のコードに基づいています。Microsoft Edge での実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。