拡張機能に 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 の読み書き

ブラウザ実装状況

Update compatibility data on GitHub
デスクトップモバイル
ChromeEdgeFirefoxOperaAndroid 版 Firefox
CookieChrome 完全対応 ありEdge 完全対応 14Firefox 完全対応 45Opera 完全対応 ありFirefox Android 完全対応 48
CookieStoreChrome 完全対応 ありEdge 完全対応 14Firefox 完全対応 45Opera 完全対応 ありFirefox Android 完全対応 48
OnChangedCauseChrome 完全対応 ありEdge 未対応 なしFirefox 完全対応 45Opera 完全対応 ありFirefox Android 完全対応 48
getChrome 完全対応 ありEdge 完全対応 14Firefox 完全対応 45
補足
完全対応 45
補足
補足 Provides access to cookies from private browsing mode and container tabs since version 52.
Opera 完全対応 ありFirefox Android 完全対応 48
getAllChrome 完全対応 ありEdge 完全対応 14
補足
完全対応 14
補足
補足 If no URL is provided, cookies are retrieved only for URLs in currently opened tabs. In Chrome, this gets all cookies on a user's machine.
Firefox 完全対応 45
補足
完全対応 45
補足
補足 Before version 52, the 'tabIds' list was empty and only cookies from the default cookie store were returned. From version 52 onwards, this has been fixed and the result includes cookies from private browsing mode and container tabs.
Opera 完全対応 ありFirefox Android 完全対応 48
getAllCookieStoresChrome 完全対応 ありEdge 完全対応 14
補足
完全対応 14
補足
補足 Always returns the same default cookie store with ID 0. All cookies belong to this store.
Firefox 完全対応 45
補足
完全対応 45
補足
補足 Before version 52, only the default cookie store was visible. From version 52 onwards, the cookie stores for private browsing mode and container tabs are also readable.
Opera 完全対応 ありFirefox Android 完全対応 48
onChangedChrome 完全対応 ありEdge 未対応 なしFirefox 完全対応 45Opera 完全対応 ありFirefox Android 完全対応 48
removeChrome 完全対応 ありEdge 完全対応 14Firefox 完全対応 45
補足
完全対応 45
補足
補足 Before version 56, this function did not remove cookies from private browsing mode. From version 56 onwards this is fixed.
Opera 完全対応 ありFirefox Android 完全対応 48
補足
完全対応 48
補足
補足 Before version 56, this function did not remove cookies from private browsing mode. From version 56 onwards this is fixed.
setChrome 完全対応 ありEdge 完全対応 14Firefox 完全対応 45
補足
完全対応 45
補足
補足 Before version 56, this function did not modify cookies in private browsing mode. From version 56 onwards this is fixed.
Opera 完全対応 ありFirefox Android 完全対応 48
補足
完全対応 48
補足
補足 Before version 56, this function did not modify cookies in private browsing mode. From version 56 onwards this is fixed.

凡例

完全対応  
完全対応
未対応  
未対応
実装ノートを参照してください。
実装ノートを参照してください。

Example extensions

謝辞

この API は Chromium の chrome.cookies API に基づいています。また、このドキュメントは cookies.json における Chromium のコードに基づいています。

Microsoft Edge での実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。

ドキュメントのタグと貢献者

このページの貢献者: Uemmra3
最終更新者: Uemmra3,