cookies

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

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

型

cookies.Cookie: HTTP cookie の情報を表す。
cookies.CookieStore (en-US): ブラウザーの cookie store を表す。
cookies.OnChangedCause (en-US): cookie の変更理由を表す。

メソッド

cookies.get() (en-US): 1 つの cookie の情報を取得する。
cookies.getAll() (en-US): 与えられたフィルターにマッチするすべての cookies を取得する。
cookies.set() (en-US): 与えられた cookie データを cookie に設定する; おなじ cookies が存在すれば上書きする。
cookies.remove() (en-US): 指定した名前の cookie を削除する。
cookies.getAllCookieStores() (en-US): すべての cookie stores を一覧する。

イベントハンドラー

cookies.onChanged (en-US): 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 の読み書き

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

// 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.

cookies

型

メソッド

イベントハンドラー

パーミッション

ブラウザーの互換性

Example extensions