Welcome Getting started API Reference Samples
Welcome Getting started API Reference Samples

chrome.cookies

  • Description

    Use the chrome.cookies API to query and modify cookies, and to be notified when they change.

  • Permissions
    cookies

Manifest #

To use the cookies API, you must declare the "cookies" permission in your manifest, along with host permissions for any hosts whose cookies you want to access. For example:

{
"name": "My extension",
...
"permissions": [
"cookies",
"*://*.google.com"
],
...
}

Examples #

You can find a simple example of using the cookies API in the examples/api/cookies directory. For other examples and for help in viewing the source code, see Samples.

Summary

Types

Represents information about an HTTP cookie.

Properties

  • domain
    string

    The domain of the cookie (e.g. "www.google.com", "example.com").

  • expirationDate
    number optional

    The expiration date of the cookie as the number of seconds since the UNIX epoch. Not provided for session cookies.

  • hostOnly
    boolean

    True if the cookie is a host-only cookie (i.e. a request's host must exactly match the domain of the cookie).

  • httpOnly
    boolean

    True if the cookie is marked as HttpOnly (i.e. the cookie is inaccessible to client-side scripts).

  • name
    string

    The name of the cookie.

  • path
    string

    The path of the cookie.

  • The cookie's same-site status (i.e. whether the cookie is sent with cross-site requests).

  • secure
    boolean

    True if the cookie is marked as Secure (i.e. its scope is limited to secure channels, typically HTTPS).

  • session
    boolean

    True if the cookie is a session cookie, as opposed to a persistent cookie with an expiration date.

  • storeId
    string

    The ID of the cookie store containing this cookie, as provided in getAllCookieStores().

  • value
    string

    The value of the cookie.

CookieDetails

Details to identify the cookie.

Properties

  • name
    string

    The name of the cookie to access.

  • storeId
    string optional

    The ID of the cookie store in which to look for the cookie. By default, the current execution context's cookie store will be used.

  • url
    string

    The URL with which the cookie to access is associated. This argument may be a full URL, in which case any data following the URL path (e.g. the query string) is simply ignored. If host permissions for this URL are not specified in the manifest file, the API call will fail.

CookieStore

Represents a cookie store in the browser. An incognito mode window, for instance, uses a separate cookie store from a non-incognito window.

Properties

  • id
    string

    The unique identifier for the cookie store.

  • tabIds
    number[]

    Identifiers of all the browser tabs that share this cookie store.

OnChangedCause

The underlying reason behind the cookie's change. If a cookie was inserted, or removed via an explicit call to "chrome.cookies.remove", "cause" will be "explicit". If a cookie was automatically removed due to expiry, "cause" will be "expired". If a cookie was removed due to being overwritten with an already-expired expiration date, "cause" will be set to "expired_overwrite". If a cookie was automatically removed due to garbage collection, "cause" will be "evicted". If a cookie was automatically removed due to a "set" call that overwrote it, "cause" will be "overwrite". Plan your response accordingly.

Enum

"evicted", "expired", "explicit", "expired_overwrite", or "overwrite"

SameSiteStatus

A cookie's 'SameSite' state (https://tools.ietf.org/html/draft-west-first-party-cookies). 'no_restriction' corresponds to a cookie set with 'SameSite=None', 'lax' to 'SameSite=Lax', and 'strict' to 'SameSite=Strict'. 'unspecified' corresponds to a cookie set without the SameSite attribute.

Enum

"no_restriction", "lax", "strict", or "unspecified"

Methods

get

chrome.cookies.get(details: CookieDetails, callback: function)

Retrieves information about a single cookie. If more than one cookie of the same name exists for the given URL, the one with the longest path will be returned. For cookies with the same path length, the cookie with the earliest creation time will be returned.

Parameters

  • callback
    function

    The callback parameter should be a function that looks like this:

    (cookie: Cookie) => {...}
    • cookie

      Contains details about the cookie. This parameter is null if no such cookie was found.

getAll

chrome.cookies.getAll(details: object, callback: function)

Retrieves all cookies from a single cookie store that match the given information. The cookies returned will be sorted, with those with the longest path first. If multiple cookies have the same path length, those with the earliest creation time will be first.

Parameters

  • details
    object

    Information to filter the cookies being retrieved.

    • domain
      string optional

      Restricts the retrieved cookies to those whose domains match or are subdomains of this one.

    • name
      string optional

      Filters the cookies by name.

    • path
      string optional

      Restricts the retrieved cookies to those whose path exactly matches this string.

    • secure
      boolean optional

      Filters the cookies by their Secure property.

    • session
      boolean optional

      Filters out session vs. persistent cookies.

    • storeId
      string optional

      The cookie store to retrieve cookies from. If omitted, the current execution context's cookie store will be used.

    • url
      string optional

      Restricts the retrieved cookies to those that would match the given URL.

  • callback
    function

    The callback parameter should be a function that looks like this:

    (cookies: Cookie[]) => {...}
    • cookies

      All the existing, unexpired cookies that match the given cookie info.

getAllCookieStores

chrome.cookies.getAllCookieStores(callback: function)

Lists all existing cookie stores.

Parameters

  • callback
    function

    The callback parameter should be a function that looks like this:

    (cookieStores: CookieStore[]) => {...}
    • cookieStores

      All the existing cookie stores.

remove

chrome.cookies.remove(details: CookieDetails, callback: function)

Deletes a cookie by name.

Parameters

  • callback
    function

    The callback parameter should be a function that looks like this:

    (details: object) => {...}
    • details
      object

      Contains details about the cookie that's been removed. If removal failed for any reason, this will be "null", and runtime.lastError will be set.

      • name
        string

        The name of the cookie that's been removed.

      • storeId
        string

        The ID of the cookie store from which the cookie was removed.

      • url
        string

        The URL associated with the cookie that's been removed.

set

chrome.cookies.set(details: object, callback: function)

Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.

Parameters

  • details
    object

    Details about the cookie being set.

    • domain
      string optional

      The domain of the cookie. If omitted, the cookie becomes a host-only cookie.

    • expirationDate
      number optional

      The expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie.

    • httpOnly
      boolean optional

      Whether the cookie should be marked as HttpOnly. Defaults to false.

    • name
      string optional

      The name of the cookie. Empty by default if omitted.

    • path
      string optional

      The path of the cookie. Defaults to the path portion of the url parameter.

    • sameSite

      The cookie's same-site status. Defaults to "unspecified", i.e., if omitted, the cookie is set without specifying a SameSite attribute.

    • secure
      boolean optional

      Whether the cookie should be marked as Secure. Defaults to false.

    • storeId
      string optional

      The ID of the cookie store in which to set the cookie. By default, the cookie is set in the current execution context's cookie store.

    • url
      string

      The request-URI to associate with the setting of the cookie. This value can affect the default domain and path values of the created cookie. If host permissions for this URL are not specified in the manifest file, the API call will fail.

    • value
      string optional

      The value of the cookie. Empty by default if omitted.

  • callback
    function

    The callback parameter should be a function that looks like this:

    (cookie: Cookie) => {...}
    • cookie

      Contains details about the cookie that's been set. If setting failed for any reason, this will be "null", and runtime.lastError will be set.

Events

onChanged

chrome.cookies.onChanged.addListener(listener: function)

Fired when a cookie is set or removed. As a special case, note that updating a cookie's properties is implemented as a two step process: the cookie to be updated is first removed entirely, generating a notification with "cause" of "overwrite" . Afterwards, a new cookie is written with the updated values, generating a second notification with "cause" "explicit".

Event

  • listener
    function

    The listener parameter should be a function that looks like this:

    (changeInfo: object) => {...}
    • changeInfo
      object
      • The underlying reason behind the cookie's change.

      • cookie

        Information about the cookie that was set or removed.

      • removed
        boolean

        True if a cookie was removed.

We serve cookies on this site to analyze traffic, remember your preferences, and optimize your experience.