chrome.cookies

Descrizione

Utilizza l'API chrome.cookies per eseguire query e modificare i cookie e per ricevere una notifica quando cambiano.

Autorizzazioni

cookies

Manifest

Per utilizzare l'API Cookies, devi dichiarare l'autorizzazione "cookies" nel file manifest, insieme alle autorizzazioni host per tutti gli host di cui vuoi accedere ai cookie. Ad esempio:

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

Partizionamento

I cookie partizionati consentono a un sito di contrassegnare determinati cookie in modo che vengano associati all'origine del frame di primo livello. Ciò significa che se il sito A è incorporato utilizzando un iframe nel sito B e nel sito C, un cookie partizionato può avere un valore diverso in ciascuno.

chrome.cookies non supporta il partizionamento, il che significa che tutti i metodi leggono e scrivono i cookie da tutte le partizioni. Il metodo cookies.set() memorizza i cookie nella partizione predefinita.

Per informazioni dettagliate sull'impatto generale del partizionamento per le estensioni, vedi Archiviazione e cookie.

Esempi

Puoi trovare un semplice esempio di utilizzo dell'API per i cookie nella directory examples/api/cookies. Per altri esempi e per assistenza nella visualizzazione del codice sorgente, vedi Esempi.

Tipi

Rappresenta le informazioni su un cookie HTTP.

Proprietà

  • dominio

    stringa

    Il dominio del cookie (ad es. "www.google.com", "example.com").

  • expirationDate

    number (facoltativo)

    La data di scadenza del cookie espressa come numero di secondi a partire dal tempo Unix. Non fornito per i cookie di sessione.

  • hostOnly

    booleano

    True se il cookie è un cookie solo host (ovvero l'host di una richiesta deve corrispondere esattamente al dominio del cookie).

  • httpOnly

    booleano

    True se il cookie è contrassegnato come HttpOnly (ovvero il cookie è inaccessibile agli script lato client).

  • nome

    stringa

    Il nome del cookie.

  • partitionKey

    CookiePartitionKey facoltativo

    Chrome 119+

    La chiave di partizione per la lettura o la modifica dei cookie con l'attributo Partitioned.

  • percorso

    stringa

    Il percorso del cookie.

  • sameSite

    SameSiteStatus

    Chrome 51+

    Lo stato same-site del cookie (ovvero se il cookie viene inviato con richieste cross-site).

  • sicuro

    booleano

    True se il cookie è contrassegnato come Secure (ovvero il suo ambito è limitato ai canali sicuri, in genere HTTPS).

  • sessione

    booleano

    Vero se il cookie è un cookie di sessione, anziché un cookie persistente con una data di scadenza.

  • storeId

    stringa

    L'ID dell'archivio cookie contenente questo cookie, come fornito in getAllCookieStores().

  • valore

    stringa

    Il valore del cookie.

CookieDetails

Chrome 88+

Dettagli per identificare il cookie.

Proprietà

  • nome

    stringa

    Il nome del cookie a cui accedere.

  • partitionKey

    CookiePartitionKey facoltativo

    Chrome 119+

    La chiave di partizione per la lettura o la modifica dei cookie con l'attributo Partitioned.

  • storeId

    stringa facoltativa

    L'ID dell'archivio cookie in cui cercare il cookie. Per impostazione predefinita, verrà utilizzato l'archivio dei cookie del contesto di esecuzione corrente.

  • url

    stringa

    L'URL a cui è associato il cookie da accedere. Questo argomento può essere un URL completo, nel qual caso tutti i dati che seguono il percorso dell'URL (ad es. la stringa di query) vengono semplicemente ignorati. Se le autorizzazioni host per questo URL non sono specificate nel file manifest, la chiamata API non andrà a buon fine.

CookiePartitionKey

Chrome 119+

Rappresenta la chiave di partizione di un cookie con stato partizionato.

Proprietà

  • hasCrossSiteAncestor

    booleano facoltativo

    Chrome 130+

    Indica se il cookie è stato impostato in un contesto cross-site. In questo modo, un sito di primo livello incorporato in un contesto cross-site non può accedere ai cookie impostati dal sito di primo livello in un contesto same-site.

  • topLevelSite

    stringa facoltativa

    Il sito di primo livello in cui è disponibile il cookie con stato partizionato.

CookieStore

Rappresenta un archivio di cookie nel browser. Ad esempio, una finestra della modalità di navigazione in incognito utilizza un archivio cookie separato da una finestra non in incognito.

Proprietà

  • id

    stringa

    L'identificatore univoco dell'archivio cookie.

  • tabIds

    number[]

    Identificatori di tutte le schede del browser che condividono questo spazio di archiviazione dei cookie.

FrameDetails

Chrome 132+

Dettagli per identificare il frame.

Proprietà

  • documentId

    stringa facoltativa

    L'identificatore univoco del documento. Se vengono forniti frameId e/o tabId, questi verranno convalidati in modo che corrispondano al documento trovato in base all'ID documento fornito.

  • frameId

    number (facoltativo)

    L'identificatore univoco del frame all'interno della scheda.

  • tabId

    number (facoltativo)

    L'identificatore univoco della scheda contenente il frame.

OnChangedCause

Chrome 44+

Il motivo alla base della modifica del cookie. Se un cookie è stato inserito o rimosso tramite una chiamata esplicita a "chrome.cookies.remove", "cause" sarà "explicit". Se un cookie è stato rimosso automaticamente a causa della scadenza, la "causa" sarà "expired" (scaduto). Se un cookie è stato rimosso perché sovrascritto con una data di scadenza già trascorsa, "cause" verrà impostato su "expired_overwrite". Se un cookie è stato rimosso automaticamente a causa della garbage collection, la "causa" sarà "evicted". Se un cookie è stato rimosso automaticamente a causa di una chiamata "set" che lo ha sovrascritto, la "causa" sarà "sovrascrittura". Pianifica la tua risposta di conseguenza.

Enum

"evicted"

"expired"

"esplicito"

"expired_overwrite"

"overwrite"

SameSiteStatus

Chrome 51+

Lo stato "SameSite" di un cookie (https://tools.ietf.org/html/draft-west-first-party-cookies). "no_restriction" corrisponde a un cookie impostato con "SameSite=None", "lax" a "SameSite=Lax" e "strict" a "SameSite=Strict". "unspecified" corrisponde a un cookie impostato senza l'attributo SameSite.

Enum

"no_restriction"

"lax"

"rigoroso"

"unspecified"

Metodi

get()

Promessa 
chrome.cookies.get(
  details: CookieDetails,
  callback?: function,
): Promise<Cookie | undefined>

Recupera le informazioni su un singolo cookie. Se per l'URL specificato esiste più di un cookie con lo stesso nome, verrà restituito quello con il percorso più lungo. Per i cookie con la stessa lunghezza del percorso, verrà restituito il cookie con l'ora di creazione meno recente.

Parametri

  • dettagli

    CookieDetails

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (cookie?: Cookie) => void

    • biscotto

      Cookie facoltativo

      Contiene dettagli sul cookie. Questo parametro è nullo se non è stato trovato alcun cookie.

Resi

  • Promise<Cookie | undefined>

    Chrome 88+

    Le promesse sono supportate solo per Manifest V3 e versioni successive, le altre piattaforme devono utilizzare i callback.

getAll()

Promessa 
chrome.cookies.getAll(
  details: object,
  callback?: function,
): Promise<Cookie[]>

Recupera tutti i cookie da un singolo spazio di archiviazione dei cookie che corrispondono alle informazioni fornite. I cookie restituiti verranno ordinati, con quelli con il percorso più lungo per primi. Se più cookie hanno la stessa lunghezza del percorso, quelli con l'ora di creazione più recente verranno visualizzati per primi. Questo metodo recupera solo i cookie per i domini per cui l'estensione dispone delle autorizzazioni host.

Parametri

  • dettagli

    oggetto

    Informazioni per filtrare i cookie recuperati.

    • dominio

      stringa facoltativa

      Limita i cookie recuperati a quelli i cui domini corrispondono a questo o sono sottodomini.

    • nome

      stringa facoltativa

      Filtra i cookie per nome.

    • partitionKey

      CookiePartitionKey facoltativo

      Chrome 119+

      La chiave di partizione per la lettura o la modifica dei cookie con l'attributo Partitioned.

    • percorso

      stringa facoltativa

      Limita i cookie recuperati a quelli il cui percorso corrisponde esattamente a questa stringa.

    • sicuro

      booleano facoltativo

      Filtra i cookie in base alla proprietà Sicuro.

    • sessione

      booleano facoltativo

      Filtra i cookie di sessione rispetto a quelli permanenti.

    • storeId

      stringa facoltativa

      L'archivio dei cookie da cui recuperare i cookie. Se omesso, verrà utilizzato l'archivio dei cookie del contesto di esecuzione corrente.

    • url

      stringa facoltativa

      Limita i cookie recuperati a quelli che corrispondono all'URL specificato.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (cookies: Cookie[]) => void

    • cookie

      Cookie[]

      Tutti i cookie esistenti e non scaduti che corrispondono alle informazioni sui cookie fornite.

Resi

  • Promise<Cookie[]>

    Chrome 88+

    Le promesse sono supportate solo per Manifest V3 e versioni successive, le altre piattaforme devono utilizzare i callback.

getAllCookieStores()

Promessa 
chrome.cookies.getAllCookieStores(
  callback?: function,
): Promise<CookieStore[]>

Elenca tutti gli archivi di cookie esistenti.

Parametri

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (cookieStores: CookieStore[]) => void

    • cookieStores

      CookieStore[]

      Tutti gli spazi di archiviazione dei cookie esistenti.

Resi

  • Promise<CookieStore[]>

    Chrome 88+

    Le promesse sono supportate solo per Manifest V3 e versioni successive, le altre piattaforme devono utilizzare i callback.

getPartitionKey()

Promise Chrome 132 e versioni successive 
chrome.cookies.getPartitionKey(
  details: FrameDetails,
  callback?: function,
): Promise<object>

La chiave di partizionamento per il frame indicato.

Parametri

  • dettagli

    FrameDetails

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (details: object) => void

    • dettagli

      oggetto

      Contiene dettagli sulla chiave di partizione recuperata.

      • partitionKey

        CookiePartitionKey

        La chiave di partizione per la lettura o la modifica dei cookie con l'attributo Partitioned.

Resi

  • Promise<object>

    Le promesse sono supportate solo per Manifest V3 e versioni successive, le altre piattaforme devono utilizzare i callback.

remove()

Promessa 
chrome.cookies.remove(
  details: CookieDetails,
  callback?: function,
): Promise<object | undefined>

Elimina un cookie in base al nome.

Parametri

  • dettagli

    CookieDetails

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (details?: object) => void

    • dettagli

      oggetto facoltativo

      Contiene dettagli sul cookie che è stato rimosso. Se la rimozione non è riuscita per qualsiasi motivo, questo valore sarà "null" e verrà impostato runtime.lastError.

      • nome

        stringa

        Il nome del cookie rimosso.

      • partitionKey

        CookiePartitionKey facoltativo

        Chrome 119+

        La chiave di partizione per la lettura o la modifica dei cookie con l'attributo Partitioned.

      • storeId

        stringa

        L'ID dell'archivio cookie da cui è stato rimosso il cookie.

      • url

        stringa

        L'URL associato al cookie rimosso.

Resi

  • Promise<object | undefined>

    Chrome 88+

    Le promesse sono supportate solo per Manifest V3 e versioni successive, le altre piattaforme devono utilizzare i callback.

set()

Promessa 
chrome.cookies.set(
  details: object,
  callback?: function,
): Promise<Cookie | undefined>

Imposta un cookie con i dati del cookie specificati; può sovrascrivere i cookie equivalenti, se esistenti.

Parametri

  • dettagli

    oggetto

    Dettagli sul cookie in fase di impostazione.

    • dominio

      stringa facoltativa

      Il dominio del cookie. Se omesso, il cookie diventa un cookie solo host.

    • expirationDate

      number (facoltativo)

      La data di scadenza del cookie espressa come numero di secondi a partire dal tempo Unix. Se omesso, il cookie diventa un cookie di sessione.

    • httpOnly

      booleano facoltativo

      Indica se il cookie deve essere contrassegnato come HttpOnly. Il valore predefinito è false.

    • nome

      stringa facoltativa

      Il nome del cookie. Se omesso, il campo è vuoto per impostazione predefinita.

    • partitionKey

      CookiePartitionKey facoltativo

      Chrome 119+

      La chiave di partizione per la lettura o la modifica dei cookie con l'attributo Partitioned.

    • percorso

      stringa facoltativa

      Il percorso del cookie. Il valore predefinito è la parte del percorso del parametro URL.

    • sameSite

      SameSiteStatus facoltativo

      Chrome 51+

      Lo stato same-site del cookie. Il valore predefinito è "unspecified", ovvero, se omesso, il cookie viene impostato senza specificare un attributo SameSite.

    • sicuro

      booleano facoltativo

      Indica se il cookie deve essere contrassegnato come sicuro. Il valore predefinito è false.

    • storeId

      stringa facoltativa

      L'ID dell'archivio cookie in cui impostare il cookie. Per impostazione predefinita, il cookie viene impostato nell'archivio cookie del contesto di esecuzione corrente.

    • url

      stringa

      L'URI della richiesta da associare all'impostazione del cookie. Questo valore può influire sui valori predefiniti di dominio e percorso del cookie creato. Se le autorizzazioni host per questo URL non sono specificate nel file manifest, la chiamata API non andrà a buon fine.

    • valore

      stringa facoltativa

      Il valore del cookie. Se omesso, il campo è vuoto per impostazione predefinita.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (cookie?: Cookie) => void

    • biscotto

      Cookie facoltativo

      Contiene i dettagli del cookie impostato. Se l'impostazione non è riuscita per qualsiasi motivo, questo valore sarà "null" e verrà impostato runtime.lastError.

Resi

  • Promise<Cookie | undefined>

    Chrome 88+

    Le promesse sono supportate solo per Manifest V3 e versioni successive, le altre piattaforme devono utilizzare i callback.

Eventi

onChanged

chrome.cookies.onChanged.addListener(
  callback: function,
)

Attivato quando un cookie viene impostato o rimosso. Come caso speciale, tieni presente che l'aggiornamento delle proprietà di un cookie viene implementato come procedura in due passaggi: il cookie da aggiornare viene prima rimosso completamente, generando una notifica con la "causa" "sovrascrittura" . Successivamente, viene scritto un nuovo cookie con i valori aggiornati, generando una seconda notifica con la "causa" "esplicita".

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

    (changeInfo: object) => void

    • changeInfo

      oggetto

      • Il motivo alla base della modifica del cookie.

      • biscotto

        Cookie

        Informazioni sul cookie impostato o rimosso.

      • rimosso

        booleano

        True se un cookie è stato rimosso.