1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
---
title: cookies.Cookie
slug: Mozilla/Add-ons/WebExtensions/API/cookies/Cookie
tags:
- API
- Add-ons
- Cookies
- Extensions
- Non-standard
- Reference
- Type
- WebExtensions
- cookie
translation_of: Mozilla/Add-ons/WebExtensions/API/cookies/Cookie
---
<div>{{AddonSidebar()}}</div>
<p>{{WebExtAPIRef("cookies")}} API の <code>Cookie</code> 型はHTTP cookie の情報を持ちます。</p>
<h2 id="型">型</h2>
<p>以下のプロパティを含むオブジェクトです。</p>
<dl class="reference-values">
<dt><code>domain</code></dt>
<dd>cookie の所属するドメイン (例えば "www.google.com" や "example.com") を示す文字列を持つ <code>string</code> 型です。</dd>
<dt><code>expirationDate</code>{{optional_inline}}</dt>
<dd>cookie の有効期限をUNIX時刻からの秒数で持つ <code>number</code> 型です。セッション cookie はこのプロパティを持っていません。</dd>
<dt><code>firstPartyDomain</code></dt>
<dd>cookie に関連付けられたファーストパーティドメインを表す文字列を格納している <code>string</code> 型です。 cookie のFirst-party isolationが無効の間は空文字列になります。詳細は <a href="https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/cookies#First-party_isolation">First-party isolation</a> をご覧ください。</dd>
<dt><code>hostOnly</code></dt>
<dd><code>boolean</code> 型です。cookie がホストオンリークッキー (リクエストのホストが cookie の指定ドメインと完全一致している場合のみ送信) である場合に <code>true</code> 、でなければ <code>false</code> になります。</dd>
<dt><code>httpOnly</code></dt>
<dd><code>boolean</code> 型です。 cookieに HttpOnly 属性 ( cookie をクライアント側スクリプトから参照できなくする属性) が付与されている場合に <code>true</code> 、でなければ <code>false</code> が格納されます。</dd>
<dt><code>name</code></dt>
<dd>cookie の名前が格納される <code>string</code> 型です。</dd>
<dt><code>path</code></dt>
<dd>cookie のパスが格納される <code>string</code> 型です。</dd>
<dt><code>secure</code></dt>
<dd><code>boolean</code> 型です。 cookie に secure 属性(暗号化通信でのみ cookie を送信する属性)が付与されている場合に <code>true</code> 、でなければ <code>false</code> になります。</dd>
<dt><code>session</code></dt>
<dd><code>boolean</code> 型です。 cookie がセッション cookie ( セッション限りで破棄される cookie )である場合に <code>true</code> 、でなければ <code>false</code> が付与されます。</dd>
<dt><code>storeId</code></dt>
<dd>この cookie が格納されている cookie ストアのIDを格納する <code>string</code> 型です。{{WebExtAPIRef("cookies.getAllCookieStores()")}}によって提供されます。</dd>
<dt><code>value</code></dt>
<dd> cookie の値を格納する <code>string</code> 型です。</dd>
</dl>
<h2 id="ブラウザ実装状況">ブラウザ実装状況</h2>
<p class="hidden">The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out <a href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> and send us a pull request.</p>
<p>{{Compat("webextensions.api.cookies.Cookie")}}</p>
<h2 id="例">例</h2>
<p>cookies API のほとんどは入力パラメータまたは戻り値の一部として使用される <code>Cookie</code> オブジェクトを含みます。例えば {{WebExtAPIRef("cookies.getAll()")}} は <code>Cookie</code> オブジェクトの配列を返します。</p>
<p>以下の例ではすべての cookie を取得し、コンソールログに <code>Cookie</code> オブジェクト中のいくつかのプロパティを出力します。</p>
<pre class="brush: js">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);</pre>
<p>{{WebExtExamples}}</p>
<div class="note"><strong>Acknowledgements</strong>
<p>この API は Chromium の <a href="https://developer.chrome.com/extensions/cookies#type-Cookie"><code>chrome.cookies</code></a> API に基づいています。 また、このドキュメントは <a href="https://chromium.googlesource.com/chromium/src/+/master/chrome/common/extensions/api/cookies.json"><code>cookies.json</code></a> における Chromium のコードに基づいています。</p>
<p>Microsoft Edge での実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。</p>
</div>
<div class="hidden">
<pre>// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</pre>
</div>
|
