Açıklama
Çerezleri sorgulamak ve değiştirmek ve değiştiklerinde bildirim almak için chrome.cookies
API'yi kullanın.
İzinler
cookies
Manifest
Çerezler API'sini kullanmak için "çerezler" manifest'ini ve çerezlerini istediğiniz ana makinelere ait ana makine izinleri tıklayın. Örneğin:
{
"name": "My extension",
...
"host_permissions": [
"*://*.google.com/"
],
"permissions": [
"cookies"
],
...
}
Bölümlendirme
Bölümlendirilmiş çerezler, bir sitenin belirli çerezlerin üst düzey çerçevenin kaynağına göre anahtarlanması gerektiğini işaretlemesine olanak tanır. Bu, A sitesi B ve C sitelerine bir iframe kullanılarak yerleştirilirse bölünmüş bir çerezin her birinde farklı bir değere sahip olabileceği anlamına gelir.
chrome.cookies
, bölümlendirmeyi desteklemez. Bu, tüm yöntemlerin tüm bölümlerden çerez okuması ve yazması anlamına gelir. cookies.set()
yöntemi, çerezleri varsayılan bölümde depolar.
Uzantılarda bölümlendirmenin genel etkisiyle ilgili ayrıntılar için şu makaleyi inceleyin: Depolama ve Çerezler.
Örnekler
Çerezler API'sini kullanmaya ilişkin basit bir örneği examples/api/cookies dizinine ekleyin. Diğer örnekler ve için Örnekler bölümüne bakın.
Türler
Cookie
HTTP çereziyle ilgili bilgileri temsil eder.
Özellikler
-
alan
dize
Çerezin alan adı (ör. "www.google.com", "example.com").
-
expirationDate
sayı isteğe bağlı
UNIX sıfır zamanından itibaren geçen saniye sayısı olarak çerezin geçerlilik bitiş tarihi. Oturum çerezleri için sağlanmaz.
-
hostOnly
boolean
Çerez yalnızca ana makineye ait bir çerezse (yani bir isteğin ana makinesi, çerezin alan adıyla tam olarak eşleşmelidir) True (doğru) değerini alır.
-
httpOnly
boolean
Çerez HttpOnly olarak işaretlenmişse (yani çerez istemci tarafı komut dosyalarına erişilemezse) doğru değerini döndürür.
-
ad
dize
Çerezin adı.
-
partitionKey
CookiePartitionKey isteğe bağlı
Chrome 119 ve üzeri sürümlerBölümlendirilmiş özelliğe sahip çerezleri okumak veya değiştirmek için kullanılan bölüm anahtarı.
-
yol
dize
Çerezin yolu.
-
sameSiteChrome 51 ve sonraki sürümler 'nı inceleyin.
Çerezin aynı site durumu (çerezin siteler arası isteklerle gönderilip gönderilmediği).
-
güvenli
boolean
Çerez Güvenli olarak işaretlenmişse (yani kapsamı güvenli kanallarla, genellikle HTTPS ile sınırlıysa) doğru değerini döndürür.
-
oturum
boolean
Çerez, son kullanma tarihi olan kalıcı bir çerezin aksine bir oturum çereziyse doğru değerini alır.
-
storeId
dize
getAllCookieStores() işlevinde sağlandığı şekilde, bu çerezi içeren çerez deposunun kimliği.
-
value
dize
Çerezin değeri.
CookieDetails
Çerezi tanımlayacak ayrıntılar.
Özellikler
-
ad
dize
Erişilecek çerezin adı.
-
partitionKey
CookiePartitionKey isteğe bağlı
Chrome 119 ve sonraki sürümler 'nı inceleyin.Bölümlendirilmiş özelliğine sahip çerezleri okumak veya değiştirmek için bölüm anahtarı.
-
storeId
dize isteğe bağlı
Çerezin aranacağı çerez deposunun kimliği. Varsayılan olarak, geçerli yürütme bağlamının çerez mağazası kullanılır.
-
url
dize
Erişilecek çerezin ilişkili olduğu URL. Bu bağımsız değişken tam bir URL olabilir.Bu durumda, URL yolunu izleyen veriler (ör. sorgu dizesi) yoksayılır. Bu URL için barındırma izinleri manifest dosyasında belirtilmezse API çağrısı başarısız olur.
CookiePartitionKey
Bölümlendirilmiş bir çerezin bölüm anahtarını temsil eder.
Özellikler
-
hasCrossSiteAncestor
boole isteğe bağlı
Chrome 130+Çerezin siteler arası bir bağlamda ayarlanıp ayarlanmadığını gösterir. Bu, siteler arası bağlamda yerleştirilmiş bir üst düzey sitenin, aynı site bağlamında üst düzey site tarafından ayarlanan çerezlere erişmesini engeller.
-
topLevelSite
dize isteğe bağlı
Bölümlendirilmiş çerezin bulunduğu üst düzey site.
CookieStore
Tarayıcıda bir çerez deposunu temsil eder. Örneğin, gizli mod penceresi, gizli olmayan bir pencereden ayrı bir çerez mağazası kullanır.
Özellikler
-
id
dize
Çerez mağazasının benzersiz tanımlayıcısıdır.
-
tabIds
numara[]
Bu çerez deposunu paylaşan tüm tarayıcı sekmelerinin tanımlayıcıları.
OnChangedCause
Çerezin değiştirilmesinin temel nedeni. Bir çerez eklendiyse veya "chrome.cookies.remove" çağrısı aracılığıyla açıkça kaldırıldıysa "neden" değeri "açık" olur. Bir çerez, geçerlilik süresi sona erdiği için otomatik olarak kaldırıldıysa "neden" değeri "expired" olur. Bir çerez, geçerlilik bitiş tarihi geçmiş bir çerezin üzerine yazıldığı için kaldırıldıysa "neden" değeri "expired_overwrite" olarak ayarlanır. Bir çerez, çöp toplama nedeniyle otomatik olarak kaldırıldıysa "neden" "çıkarılır". Bir çerez, üzerine yazılan bir "set" çağrısı nedeniyle otomatik olarak kaldırıldıysa "neden" değeri "overwrite" olur. Yanıtınızı buna göre planlayın.
Enum
"explicit"
"overwrite"
SameSiteStatus
Çerezin "SameSite" durumu (https://tools.ietf.org/html/draft-west-first-party-cookies). "no_restriction", "SameSite=None" ile ayarlanmış bir çereze, "lax" "SameSite=Lax" ile ayarlanmış bir çereze ve "strict" "SameSite=Strict" ile ayarlanmış bir çereze karşılık gelir. "belirtilmemiş" SameSite özelliğine sahip olmayan bir çerez grubuna karşılık gelir.
Enum
"lax"
"strict"
"unspecified"
Yöntemler
get()
chrome.cookies.get(
details: CookieDetails,
callback?: function,
)
Tek bir çerez hakkında bilgi getirir. Belirtilen URL için aynı ada sahip birden fazla çerez varsa yolu en uzun olan çerez döndürülür. Aynı yol uzunluğuna sahip çerezler için oluşturulma zamanı en erken olan çerez döndürülür.
Parametreler
İadeler
-
Promise<Cookie | undefined>
Chrome 88 ve sonraki sürümler 'nı inceleyin.Sözler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.
getAll()
chrome.cookies.getAll(
details: object,
callback?: function,
)
Belirtilen bilgilerle eşleşen tüm çerezleri tek bir çerez deposundan alır. Döndürülen çerezler, en uzun yola sahip olanlar ilk sırada olacak şekilde sıralanır. Birden fazla çerez aynı yol uzunluğuna sahipse en erken oluşturulma zamanına sahip olanlar ilk olur. Bu yöntem yalnızca uzantının ana makine izinlerine sahip olduğu alanların çerezlerini alır.
Parametreler
-
ayrıntılar
nesne
Alınan çerezleri filtrelemek için gereken bilgiler.
-
alan
dize isteğe bağlı
Alınan çerezleri, alanları bunun alt alanı olan veya bunlarla eşleşen kullanıcılarla kısıtlar.
-
ad
dize isteğe bağlı
Çerezleri ada göre filtreler.
-
partitionKey
CookiePartitionKey isteğe bağlı
Chrome 119 ve sonraki sürümler 'nı inceleyin.Bölümlendirilmiş özelliğe sahip çerezleri okumak veya değiştirmek için kullanılan bölüm anahtarı.
-
yol
dize isteğe bağlı
Alınan çerezleri, yolu bu dizeyle tam olarak eşleşenlerle kısıtlar.
-
güvenli
boole isteğe bağlı
Çerezleri kendi Güvenli mülklerine göre filtreler.
-
oturum
boole isteğe bağlı
Oturumu ve kalıcı çerezleri filtreler.
-
storeId
dize isteğe bağlı
Çerezlerin alınacağı çerez deposu. Atlanırsa geçerli yürütme bağlamının çerez deposu kullanılır.
-
url
dize isteğe bağlı
Alınan çerezleri, belirtilen URL ile eşleşenlerle kısıtlar.
-
-
geri çağırma
işlev isteğe bağlı
callback
parametresi şu şekilde görünür:(cookies: Cookie[]) => void
-
Cloud Console dışındaki Google Cloud sitelerindeki
Çerez[]
Belirtilen çerez bilgileriyle eşleşen, mevcut ve süresi dolmamış tüm çerezler.
-
İadeler
-
Promise<Çerez[]>
Chrome 88 ve sonraki sürümler 'nı inceleyin.Sözler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.
getAllCookieStores()
chrome.cookies.getAllCookieStores(
callback?: function,
)
Mevcut tüm çerez depolarını listeler.
Parametreler
-
geri çağırma
işlev isteğe bağlı
callback
parametresi şu şekilde görünür:(cookieStores: CookieStore[]) => void
-
cookieStores
Mevcut tüm çerez mağazaları.
-
İadeler
-
Promise<CookieStore[]>
Chrome 88 ve sonraki sürümlerVaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.
remove()
chrome.cookies.remove(
details: CookieDetails,
callback?: function,
)
Çerezi ada göre siler.
Parametreler
-
ayrıntılar
-
geri çağırma
işlev isteğe bağlı
callback
parametresi şu şekilde görünür:(details?: object) => void
-
ayrıntılar
nesne isteğe bağlı
Kaldırılan çerezle ilgili ayrıntıları içerir. Kaldırma işlemi herhangi bir nedenle başarısız olursa bu değer "null" olur ve
runtime.lastError
ayarlanır.-
ad
dize
Kaldırılan çerezin adı.
-
partitionKey
CookiePartitionKey isteğe bağlı
Chrome 119 ve üzeri sürümlerBölümlendirilmiş özelliğine sahip çerezleri okumak veya değiştirmek için bölüm anahtarı.
-
storeId
dize
Çerezin kaldırıldığı çerez deposunun kimliği.
-
url
dize
Kaldırılan çerezle ilişkili URL.
-
-
İadeler
-
Promise<object | tanımlanmadı>
Chrome 88 ve sonraki sürümlerSözler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.
set()
chrome.cookies.set(
details: object,
callback?: function,
)
Belirtilen çerez verilerine sahip bir çerez ayarlar; eşdeğer çerezlerin üzerine yazabilir.
Parametreler
-
ayrıntılar
nesne
Ayarlanan çerezle ilgili ayrıntılar.
-
alan
dize isteğe bağlı
Çerezin alanı. Atlanırsa çerez yalnızca ana makine çerezi olur.
-
expirationDate
sayı isteğe bağlı
UNIX döneminden sonraki saniye sayısı olarak çerezin geçerlilik bitiş tarihi. Atlanırsa çerez bir oturum çerezi olur.
-
httpOnly
boole isteğe bağlı
Çerezin HttpOnly olarak işaretlenip işaretlenmeyeceğini belirler. Varsayılan değer yanlıştır.
-
ad
dize isteğe bağlı
Çerezin adı. Atlanırsa varsayılan olarak boştur.
-
partitionKey
CookiePartitionKey isteğe bağlı
Chrome 119 ve sonraki sürümler 'nı inceleyin.Bölümlendirilmiş özelliğe sahip çerezleri okumak veya değiştirmek için kullanılan bölüm anahtarı.
-
yol
dize isteğe bağlı
Çerezin yolu. Varsayılan olarak URL parametresinin yol kısmı kullanılır.
-
sameSite
SameSiteStatus isteğe bağlı
Chrome 51 ve sonraki sürümlerÇerezin aynı sitede durumu. Varsayılan olarak "belirtilmemiş", yani atlanırsa çerez bir SameSite özelliği belirtilmeden ayarlanır.
-
güvenli
boole isteğe bağlı
Çerezin Güvenli olarak işaretlenip işaretlenmeyeceğini belirler. Varsayılan olarak yanlış değerine ayarlanır.
-
storeId
dize isteğe bağlı
Çerezin ayarlanacağı çerez deposunun kimliği. Varsayılan olarak çerez, geçerli yürütme bağlamının çerez deposunda ayarlanır.
-
url
dize
Çerezin ayarıyla ilişkilendirilecek istek URI'si. Bu değer, oluşturulan çerezin varsayılan alan adını ve yol değerlerini etkileyebilir. Manifest dosyasında bu URL için ana makine izinleri belirtilmemişse API çağrısı başarısız olur.
-
value
dize isteğe bağlı
Çerezin değeri. Atlanırsa varsayılan olarak boştur.
-
-
geri çağırma
işlev isteğe bağlı
callback
parametresi şu şekilde görünür:(cookie?: Cookie) => void
-
çerez
Çerez isteğe bağlı
Ayarlanan çerezle ilgili ayrıntıları içerir. Ayar herhangi bir nedenle başarısız olursa bu değer "null" olur ve
runtime.lastError
ayarlanır.
-
İadeler
-
Promise<Cookie | undefined>
Chrome 88 ve sonraki sürümler 'nı inceleyin.Sözler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.
Etkinlikler
onChanged
chrome.cookies.onChanged.addListener(
callback: function,
)
Bir çerez oluşturulduğunda veya kaldırıldığında tetiklenir. Özel bir durum olarak, bir çerezin özelliklerinin güncellenmesinin iki adımlı bir işlem olarak uygulandığını unutmayın: Güncellenecek çerez önce tamamen kaldırılır ve "neden"i "yeniden yazma" olan bir bildirim oluşturulur. Ardından, güncellenmiş değerlerle yeni bir çerez yazılır ve "neden" değeri "explicit" olan ikinci bir bildirim oluşturulur.
Parametreler
-
geri çağırma
işlev
callback
parametresi şu şekilde görünür:(changeInfo: object) => void
-
changeInfo
nesne
-
neden
Çerezin değişiminin altında yatan neden.
-
çerez
Ayarlanan veya kaldırılan çerez hakkında bilgi.
-
kaldırıldı
boolean
Çerez kaldırıldıysa doğru değerini döndürür.
-
-