chrome.cookies (original) (raw)
Manifest V3
chrome.cookies
Beschreibung
Mit der chrome.cookies API können Sie Cookies abfragen und ändern und sich benachrichtigen lassen, wenn sie sich ändern.
Berechtigungen
cookies
Wenn Sie die Cookies API verwenden möchten, müssen Sie die Berechtigung "cookies" in Ihrem Manifest zusammen mit Hostberechtigungen für alle Hosts deklarieren, auf deren Cookies Sie zugreifen möchten. Beispiel:
{
"name": "My extension",
...
"host_permissions": [
"*://*.google.com/"
],
"permissions": [
"cookies"
],
...
}
Partitionierung
Mit partitionierten Cookies kann eine Website festlegen, dass bestimmte Cookies anhand des Ursprungs des Frames der obersten Ebene verschlüsselt werden sollen. Wenn Website A beispielsweise mithilfe eines iFrames in Website B und Website C eingebettet ist, können die eingebetteten Versionen eines partitionierten Cookies von A unterschiedliche Werte auf B und C haben.
Standardmäßig werden alle API-Methoden für nicht partitionierte Cookies ausgeführt. Mit der Property partitionKey kann dieses Verhalten überschrieben werden.
Weitere Informationen zu den allgemeinen Auswirkungen der Partitionierung für Erweiterungen finden Sie unter Speicher und Cookies.
Beispiele
Ein einfaches Beispiel für die Verwendung der Cookies API finden Sie im Verzeichnis examples/api/cookies. Weitere Beispiele und Hilfe beim Ansehen des Quellcodes finden Sie unter Beispiele.
Typen
Cookie
Stellt Informationen zu einem HTTP-Cookie dar.
Attribute
- Die Domain des Cookies, z.B. „www.google.com“ oder „beispiel.de“.
- expirationDate
number optional
Das Ablaufdatum des Cookies als Anzahl der Sekunden seit der UNIX-Epoche. Nicht für Sitzungscookies verfügbar. - „True“, wenn das Cookie ein Host-only-Cookie ist. Das bedeutet, dass der Host einer Anfrage genau mit der Domain des Cookies übereinstimmen muss.
- „True“, wenn das Cookie als „HttpOnly“ markiert ist. Das bedeutet, dass das Cookie für clientseitige Skripts nicht zugänglich ist.
- Der Name des Cookies.
- partitionKey
CookiePartitionKey optional
Der Partitionierungsschlüssel zum Lesen oder Ändern von Cookies mit dem Attribut „Partitioned“. - Der Pfad des Cookies.
- Der SameSite-Status des Cookies, d.h. ob das Cookie mit websiteübergreifenden Anfragen gesendet wird.
- „True“, wenn das Cookie als „Secure“ (sicher) gekennzeichnet ist. Das bedeutet, dass sein Bereich auf sichere Channels beschränkt ist, in der Regel HTTPS.
- „True“, wenn das Cookie ein Sitzungs-Cookie ist und kein dauerhaftes Cookie mit Ablaufdatum.
- Die ID des Cookie-Speichers, der dieses Cookie enthält, wie in getAllCookieStores() angegeben.
- Der Wert des Cookies.
CookieDetails
Details zur Identifizierung des Cookies.
Attribute
- Der Name des Cookies, auf den zugegriffen werden soll.
- partitionKey
CookiePartitionKey optional
Der Partitionierungsschlüssel zum Lesen oder Ändern von Cookies mit dem Attribut „Partitioned“. - Die ID des Cookie-Speichers, in dem nach dem Cookie gesucht werden soll. Standardmäßig wird der Cookie-Speicher des aktuellen Ausführungskontexts verwendet.
- Die URL, mit der das Cookie für den Zugriff verknüpft ist. Dieses Argument kann eine vollständige URL sein. In diesem Fall werden alle Daten, die auf den URL-Pfad folgen (z. B. der Abfragestring), einfach ignoriert. Wenn in der Manifestdatei keine Hostberechtigungen für diese URL angegeben sind, schlägt der API-Aufruf fehl.
CookiePartitionKey
Stellt den Partitionierungsschlüssel eines partitionierten Cookies dar.
Attribute
- hasCrossSiteAncestor
boolean optional
Gibt an, ob das Cookie in einem websiteübergreifenden Kontext gesetzt wurde. So wird verhindert, dass eine Top-Level-Website, die in einem websiteübergreifenden Kontext eingebettet ist, auf Cookies zugreifen kann, die von der Top-Level-Website in einem SameSite-Kontext gesetzt wurden. - topLevelSite
String optional
Die Top-Level-Website, auf der das partitionierte Cookie verfügbar ist.
CookieStore
Stellt einen Cookie-Speicher im Browser dar. Ein Inkognitofenster verwendet beispielsweise einen separaten Cookie-Speicher als ein normales Fenster.
Attribute
- Die eindeutige Kennung für den Cookie-Speicher.
- Kennungen aller Browser-Tabs, die diesen Cookie-Speicher gemeinsam nutzen.
FrameDetails
Details zur Identifizierung des Frames.
Attribute
- documentId
String optional
Die eindeutige Kennung für das Dokument. Wenn die frameId und/oder tabId angegeben werden, werden sie validiert, um mit dem Dokument übereinzustimmen, das anhand der angegebenen Dokument-ID gefunden wurde. - Die eindeutige Kennung für den Frame auf dem Tab.
- Die eindeutige Kennung für den Tab, der den Frame enthält.
OnChangedCause
Der zugrunde liegende Grund für die Änderung des Cookies. Wenn ein Cookie über einen expliziten Aufruf von „chrome.cookies.remove“ eingefügt oder entfernt wurde, ist „cause“ „explicit“. Wenn ein Cookie aufgrund des Ablaufs automatisch entfernt wurde, ist „cause“ (Ursache) „expired“ (abgelaufen). Wenn ein Cookie entfernt wurde, weil es mit einem bereits abgelaufenen Ablaufdatum überschrieben wurde, wird „cause“ auf „expired_overwrite“ gesetzt. Wenn ein Cookie aufgrund der Garbage Collection automatisch entfernt wurde, ist „cause“ (Ursache) „evicted“ (entfernt). Wenn ein Cookie aufgrund eines „set“-Aufrufs, durch den es überschrieben wurde, automatisch entfernt wurde, ist „cause“ (Ursache) „overwrite“ (Überschreiben). Planen Sie Ihre Antwort entsprechend.
Enum
"evicted"
„expired“
„explicit“
"expired_overwrite"
"overwrite"
SameSiteStatus
Der „SameSite“-Status eines Cookies (https://tools.ietf.org/html/draft-west-first-party-cookies). „no_restriction“ entspricht einem Cookie, das mit „SameSite=None“ festgelegt wurde, „lax“ entspricht „SameSite=Lax“ und „strict“ entspricht „SameSite=Strict“. „unspecified“ entspricht einem Cookie, das ohne das SameSite-Attribut gesetzt wurde.
Enum
"no_restriction"
"lax"
"strict"
"unspecified"
Methoden
get()
chrome.cookies.get(
details: CookieDetails,
): Promise<Cookie | undefined>
Ruft Informationen zu einem einzelnen Cookie ab. Wenn für die angegebene URL mehrere Cookies mit demselben Namen vorhanden sind, wird das Cookie mit dem längsten Pfad zurückgegeben. Bei Cookies mit derselben Pfadlänge wird das Cookie mit der frühesten Erstellungszeit zurückgegeben.
Parameter
Ausgabe
- Promise<Cookie | undefined>
getAll()
chrome.cookies.getAll(
details: object,
): Promise<Cookie[]>
Ruft alle Cookies aus einem einzelnen Cookie-Speicher ab, die den angegebenen Informationen entsprechen. Die zurückgegebenen Cookies werden sortiert, wobei die mit dem längsten Pfad zuerst aufgeführt werden. Wenn mehrere Cookies dieselbe Pfadlänge haben, werden diejenigen mit der frühesten Erstellungszeit zuerst aufgeführt. Mit dieser Methode werden nur Cookies für Domains abgerufen, für die die Erweiterung Hostberechtigungen hat.
Parameter
- Informationen zum Filtern der abgerufenen Cookies.
- Beschränkt die abgerufenen Cookies auf diejenigen, deren Domains mit dieser übereinstimmen oder Subdomains davon sind.
- Filtert die Cookies nach Name.
- partitionKey
CookiePartitionKey optional
Der Partitionierungsschlüssel zum Lesen oder Ändern von Cookies mit dem Attribut „Partitioned“. - Beschränkt die abgerufenen Cookies auf diejenigen, deren Pfad genau mit diesem String übereinstimmt.
- Filtert die Cookies nach ihrem „Secure“-Attribut.
- Filtert Sitzungs- und dauerhafte Cookies heraus.
- Der Cookie-Speicher, aus dem Cookies abgerufen werden sollen. Wenn nichts angegeben ist, wird der Cookie-Speicher des aktuellen Ausführungskontexts verwendet.
- Beschränkt die abgerufenen Cookies auf diejenigen, die mit der angegebenen URL übereinstimmen.
Ausgabe
getAllCookieStores()
chrome.cookies.getAllCookieStores(): Promise<CookieStore[]>
Alle vorhandenen Cookie-Speicher auflisten
Ausgabe
getPartitionKey()
chrome.cookies.getPartitionKey(
details: FrameDetails,
): Promise
Der Partitionierungsschlüssel für den angegebenen Frame.
Parameter
Ausgabe
remove()
chrome.cookies.remove(
details: CookieDetails,
): Promise<object | undefined>
Löscht ein Cookie nach Name.
Parameter
Ausgabe
- Promise<object | undefined>
set()
chrome.cookies.set(
details: object,
): Promise<Cookie | undefined>
Setzt ein Cookie mit den angegebenen Cookie-Daten. Vorhandene entsprechende Cookies werden möglicherweise überschrieben.
Parameter
- Details zum gesetzten Cookie.
- Die Domain des Cookies. Wird diese Option nicht angegeben, wird das Cookie zu einem Host-only-Cookie.
- expirationDate
number optional
Das Ablaufdatum des Cookies als Anzahl der Sekunden seit der UNIX-Epoche. Wenn es weggelassen wird, wird das Cookie zu einem Sitzungscookie. - httpOnly
boolean optional
Gibt an, ob das Cookie als „HttpOnly“ markiert werden soll. Die Standardeinstellung ist "false". - Der Name des Cookies. Wenn keine Angabe gemacht wird, ist das Feld standardmäßig leer.
- partitionKey
CookiePartitionKey optional
Der Partitionierungsschlüssel zum Lesen oder Ändern von Cookies mit dem Attribut „Partitioned“. - Der Pfad des Cookies. Der Standardwert ist der Pfadteil des URL-Parameters.
- sameSite
SameSiteStatus optional
Der SameSite-Status des Cookies. Der Standardwert ist „unspecified“. Wenn das Attribut also weggelassen wird, wird das Cookie ohne Angabe eines SameSite-Attributs gesetzt. - Gibt an, ob das Cookie als „Secure“ gekennzeichnet werden soll. Die Standardeinstellung ist "false".
- Die ID des Cookie-Speichers, in dem das Cookie festgelegt werden soll. Standardmäßig wird das Cookie im Cookie-Speicher des aktuellen Ausführungskontexts festgelegt.
- Der Anfrage-URI, der mit der Festlegung des Cookies verknüpft werden soll. Dieser Wert kann sich auf die Standardwerte für Domain und Pfad des erstellten Cookies auswirken. Wenn in der Manifestdatei keine Hostberechtigungen für diese URL angegeben sind, schlägt der API-Aufruf fehl.
- Der Wert des Cookies. Wenn keine Angabe gemacht wird, ist das Feld standardmäßig leer.
Ausgabe
- Promise<Cookie | undefined>
Ereignisse
onChanged
chrome.cookies.onChanged.addListener(
callback: function,
)
Wird ausgelöst, wenn ein Cookie gesetzt oder entfernt wird. Als Sonderfall ist zu beachten, dass die Aktualisierung der Eigenschaften eines Cookies in zwei Schritten erfolgt: Das zu aktualisierende Cookie wird zuerst vollständig entfernt, wodurch eine Benachrichtigung mit dem „cause“-Wert „overwrite“ generiert wird. Anschließend wird ein neues Cookie mit den aktualisierten Werten geschrieben, wodurch eine zweite Benachrichtigung mit dem „Grund“ „explizit“ generiert wird.
Parameter
- Der Parameter
callbacksieht so aus:
(changeInfo: object) => void- Der zugrunde liegende Grund für die Änderung des Cookies.
- Informationen zum Cookie, das gesetzt oder entfernt wurde.
- Wahr, wenn ein Cookie entfernt wurde.
- Der zugrunde liegende Grund für die Änderung des Cookies.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-10-01 (UTC).