cookies.Cookie

cookies API の Cookie 型はHTTP cookie の情報を持ちます。

型

以下のプロパティを含むオブジェクトです。

domain
cookie の所属するドメイン (例えば "www.google.com" や "example.com") を示す文字列を持つ string 型です。
expirationDateOptional
cookie の有効期限をUNIX時刻からの秒数で持つ number 型です。セッション cookie はこのプロパティを持っていません。
firstPartyDomain
cookie に関連付けられたファーストパーティドメインを表す文字列を格納している string 型です。 cookie のFirst-party isolationが無効の間は空文字列になります。詳細は First-party isolation をご覧ください。
hostOnly
boolean 型です。cookie がホストオンリークッキー (リクエストのホストが cookie の指定ドメインと完全一致している場合のみ送信) である場合に true 、でなければ false になります。
httpOnly
boolean 型です。 cookieに HttpOnly 属性 ( cookie をクライアント側スクリプトから参照できなくする属性) が付与されている場合に true 、でなければ false が格納されます。
name
cookie の名前が格納される string 型です。
path
cookie のパスが格納される string 型です。
secure
boolean 型です。 cookie に secure 属性(暗号化通信でのみ cookie を送信する属性)が付与されている場合に true 、でなければ false になります。
session
boolean 型です。 cookie がセッション cookie ( セッション限りで破棄される cookie )である場合に true 、でなければ false が付与されます。
storeId
この cookie が格納されている cookie ストアのIDを格納する string 型です。cookies.getAllCookieStores()によって提供されます。
value
 cookie の値を格納する string 型です。

ブラウザ実装状況

Update compatibility data on GitHub
デスクトップモバイル
ChromeEdgeFirefoxOperaSafariAndroid 版 Firefox
CookieChrome 完全対応 ありEdge 完全対応 14Firefox 完全対応 45Opera 完全対応 ありSafari 完全対応 14Firefox Android 完全対応 48
firstPartyDomainChrome 未対応 なしEdge 未対応 なしFirefox 完全対応 59Opera 未対応 なしSafari 未対応 なしFirefox Android 完全対応 59
sameSiteChrome 完全対応 ありEdge 完全対応 79Firefox 完全対応 63Opera 未対応 なしSafari 完全対応 14
補足
完全対応 14
補足
補足 Only supports explicit.
Firefox Android 完全対応 63

凡例

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

例

cookies API のほとんどは入力パラメータまたは戻り値の一部として使用される Cookie オブジェクトを含みます。例えば cookies.getAll() は Cookie オブジェクトの配列を返します。

以下の例ではすべての cookie を取得し、コンソールログに  Cookie オブジェクト中のいくつかのプロパティを出力します。

function logCookies(cookies) {
  for (cookie of cookies) {
    console.log(`Domain: ${cookie.domain}`);
    console.log(`Name: ${cookie.name}`);
    console.log(`Value: ${cookie.value}`);
    console.log(`Persistent: ${!cookie.session}`);
  }
}

var gettingAll = browser.cookies.getAll({});
gettingAll.then(logCookies);
Acknowledgements

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

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