API referansı

Çoğu uzantının çalışması için bir veya daha fazla Chrome Extensions API'ye erişmesi gerekir. Bu API referansı, uzantılarda kullanılabilen API'leri açıklar ve örnek kullanım alanları sunar.

Sık kullanılan Extensions API özellikleri

Uzantılar API'si, uzantıların çalışmasını sağlayan yöntem ve özellikleri ve manifest.json dosyasının genellikle, her zaman olmasa da manifest alanlarını içeren bir ad alanından oluşur. Örneğin, chrome.action ad alanı manifest dosyasında bir "action" nesnesinin olmasını gerektirir. Birçok API, manifest dosyasında da izinlere ihtiyaç duyar.

Uzantı API'lerindeki yöntemler, aksi belirtilmedikçe eşzamansızdır. Eşzamansız yöntemler, bunlara çağrı yapan işlemin tamamlanmasını beklemeden anında geri döner. Bu yöntemlerin sonuçlarını elde etmek için sözleri kullanın. Daha fazla bilgi için Eşzamansız yöntemler bölümüne bakın.

Chrome Uzantısı API'leri

accessibilityFeatures

Chrome'un erişilebilirlik özelliklerini yönetmek için chrome.accessibilityFeatures API'yi kullanın. Bu API, bağımsız erişilebilirlik özelliklerini almak ve ayarlamak için API türündeki ChromeSetting prototipini kullanır. Özellik durumlarını alabilmesi için uzantının accessibilityFeatures.read izni istemesi gerekir. Özellik durumunu değiştirebilmek için uzantının accessibilityFeatures.modify iznine ihtiyacı var. accessibilityFeatures.modify ifadesinin, accessibilityFeatures.read iznini ima etmediğini unutmayın.

işlem
Chrome 88 ve üstü sürümler MV3 ve sonraki sürümler

Google Chrome araç çubuğunda uzantının simgesini kontrol etmek için chrome.action API'sını kullanın.

alarmlar

Kodu periyodik olarak veya gelecekteki belirli bir zamanda çalışacak şekilde planlamak için chrome.alarms API'yi kullanın.

ses
Yalnızca Chrome 59 ve sonraki sürümler Yalnızca ChromeOS'te

chrome.audio API, kullanıcıların sisteme bağlı ses cihazları hakkında bilgi edinmelerine ve bu cihazları kontrol etmelerine olanak tanır. Bu API şu anda yalnızca ChromeOS için kiosk modunda kullanılabilir.

yer işaretleri

Yer işaretleri oluşturmak, düzenlemek ve başka şekillerde değiştirmek için chrome.bookmarks API'yi kullanın. Ayrıca, özel bir Yer İşareti Yöneticisi sayfası oluşturmak için kullanabileceğiniz Sayfaları Geçersiz Kılma konusuna da bakabilirsiniz.

browsingData

Kullanıcının yerel profilinden tarama verilerini kaldırmak için chrome.browsingData API'yi kullanın.

certificateProvider
Yalnızca Chrome 46 ve üstü ChromeOS

Sertifikaları, TLS kimlik doğrulamalarında kullanabilecekleri platforma göstermek için bu API'yi kullanın.

komutlar

Uzantınızdaki işlemleri (ör. tarayıcı işlemini açma veya uzantıya komut gönderme işlemi) tetikleyen klavye kısayolları eklemek için komutlar API'sını kullanın.

contentSettings

Web sitelerinin çerezler, JavaScript ve eklentiler gibi özellikleri kullanıp kullanamayacağını kontrol eden ayarları değiştirmek için chrome.contentSettings API'sini kullanın. Daha genel olarak ifade etmek gerekirse içerik ayarları, Chrome'un davranışını global olarak değil, site bazında özelleştirmenize olanak tanır.

contextMenus

Google Chrome'un içerik menüsüne öğe eklemek için chrome.contextMenus API'sını kullanın. İçerik menüsü eklemelerinizin ne tür nesnelere (ör. resimler, köprüler ve sayfalar) uygulanacağını seçebilirsiniz.

çerezler

Çerezleri sorgulamak, değiştirmek ve değişiklik olduğunda bildirim almak için chrome.cookies API'yi kullanın.

debugger

chrome.debugger API, Chrome'un uzaktan hata ayıklama protokolü için alternatif bir aktarım işlevi görür. Ağ etkileşimini değerlendirmek, JavaScript'te hata ayıklamak, DOM ve CSS'yi değiştirmek vb. için bir veya daha fazla sekmeye ekleme yapmak üzere chrome.debugger kullanın.tabIdtabId

declarativeContent

Sayfanın içeriğini okuma izni gerektirmeden, sayfanın içeriğine göre işlem yapmak için chrome.declarativeContent API'sini kullanın.

declarativeNetRequest
Chrome 84 ve sonraki sürümler

chrome.declarativeNetRequest API, bildirim temelli kurallar belirleyerek ağ isteklerini engellemek veya değiştirmek için kullanılır. Bu sayede uzantılar, ağ isteklerine müdahale edip içeriklerini görüntülemeden değişiklik yapabilir, böylece daha fazla gizlilik sağlar.

desktopCapture

Masaüstü Yakalama API'sı ekranın, bağımsız pencerelerin veya tek tek sekmelerin içeriğini yakalar.

devtools.inspectedWindow

İncelenen pencereyle etkileşimde bulunmak için chrome.devtools.inspectedWindow API'sını kullanın: İncelenen sayfanın sekme kimliğini edinin, kodu denetlenen pencere bağlamında değerlendirin, sayfayı yeniden yükleyin veya sayfadaki kaynakların listesini edinin.

devtools.network

Geliştirici Araçları tarafından Ağ panelinde görüntülenen ağ istekleri hakkında bilgi almak için chrome.devtools.network API'sını kullanın.

devtools.panels

Uzantınızı Geliştirici Araçları penceresi kullanıcı arayüzüne entegre etmek için chrome.devtools.panels API'sını kullanın: Kendi panellerinizi oluşturun, mevcut panellere erişin ve kenar çubukları ekleyin.

devtools.recorder
Chrome 105 ve sonraki sürümler

Geliştirici Araçları'nda Kaydedici panelini özelleştirmek için chrome.devtools.recorder API'sini kullanın.

dns
Yeni geliştirilenler kanalı

DNS çözünürlüğü için chrome.dns API'yi kullanın.

documentScan
Yalnızca Chrome 44 ve üstü ChromeOS

Ekli belge tarayıcılardan görüntü keşfetmek ve almak için chrome.documentScan API'yi kullanın.

dom
Chrome 88 ve sonraki sürümler

Uzantılara yönelik özel DOM API'lerine erişmek için chrome.dom API'yi kullanın

indirilenler

İndirmeleri programlı bir şekilde başlatmak, izlemek, değiştirmek ve aramak için chrome.downloads API'sini kullanın.

enterprise.deviceAttributes
Chrome 46 ve üstü Yalnızca Chrome OS Politika gerektirir

Cihaz özelliklerini okumak için chrome.enterprise.deviceAttributes API'yi kullanın. Not: Bu API yalnızca kurumsal politika tarafından zorunlu yüklenmiş uzantılar tarafından kullanılabilir.

enterprise.hardwarePlatform
Chrome 71 ve sonraki sürümler Politika gerektiriyor

Tarayıcının çalıştığı donanım platformunun üreticisini ve modelini almak için chrome.enterprise.hardwarePlatform API'yi kullanın. Not: Bu API yalnızca kurumsal politikaya göre yüklenen uzantılar tarafından kullanılabilir.

enterprise.networkingAttributes
Chrome 85 ve sonraki sürümler Yalnızca ChromeOS Politika gerektirir

Mevcut ağınızla ilgili bilgileri okumak için chrome.enterprise.networkingAttributes API'yi kullanın. Not: Bu API yalnızca kurumsal politika tarafından zorunlu yüklenmiş uzantılar tarafından kullanılabilir.

enterprise.platformKeys
Yalnızca ChromeOS Politika gerektirir

Bu anahtarlar için anahtar oluşturmak ve sertifikaları yüklemek için chrome.enterprise.platformKeys API'yi kullanın. Sertifikalar platform tarafından yönetilecek ve TLS kimlik doğrulaması, ağ erişimi veya {@link platformKeys chrome.platformKeys} üzerinden başka bir uzantı tarafından kullanılabilir.

etkinlikler

chrome.events ad alanı, ilginç bir şey olduğunda sizi bilgilendirmek için etkinlik gönderen API'lerin kullandığı yaygın türleri içerir.

uzantı

chrome.extension API, herhangi bir uzantı sayfası tarafından kullanılabilecek yardımcı programlar içerir. İleti Aktarma bölümünde ayrıntılı olarak açıklandığı gibi, bir uzantı ile içeriğin komut dosyaları veya uzantılar arasında mesaj alışverişi desteği içerir.

extensionTypes

chrome.extensionTypes API, Chrome uzantıları için tür bildirimleri içerir.

fileBrowserHandler
Yalnızca ChromeOS Yalnızca ön plan

Chrome OS dosya tarayıcısını genişletmek için chrome.fileBrowserHandler API'sini kullanın. Örneğin, kullanıcıların web sitenize dosya yükleyebilmesini sağlamak için bu API'yi kullanabilirsiniz.

fileSystemProvider
Yalnızca ChromeOS

Chrome OS'teki dosya yöneticisinden erişilebilen dosya sistemleri oluşturmak için chrome.fileSystemProvider API'yi kullanın.

fontSettings

Chrome'un yazı tipi ayarlarını yönetmek için chrome.fontSettings API'yi kullanın.

gcm

Firebase Cloud Messaging (FCM) üzerinden mesaj gönderip almak üzere uygulama ve uzantıları etkinleştirmek için chrome.gcm kullanın.

geçmiş

Tarayıcının ziyaret edilen sayfa kaydıyla etkileşim kurmak için chrome.history API'sini kullanın. Tarayıcı geçmişindeki URL'leri ekleyebilir, kaldırabilir ve sorgulayabilirsiniz. Geçmiş sayfasını kendi sürümünüzle geçersiz kılmak için Sayfaları Geçersiz Kılma konusuna bakın.

i18n

Uygulamanızın veya uzantınızın tamamında uluslararasılaştırmayı uygulamak için chrome.i18n altyapısını kullanın.

kimlik

OAuth2 erişim jetonları almak için chrome.identity API'yi kullanın.

boşta

Makinenin boşta kalma durumunun ne zaman değiştiğini algılamak için chrome.idle API'yi kullanın.

input.ime

Chrome OS için özel bir IME uygulamak için chrome.input.ime API'yi kullanın. Bu, uzantınızın tuş vuruşlarını işlemesine, besteyi ayarlamasına ve aday pencereyi yönetmesine olanak tanır.

instanceID
Chrome 44 ve sonraki sürümler

Örnek Kimliği hizmetine erişmek için chrome.instanceID kullanın.

loginState
Yalnızca Chrome 78 ve sonraki sürümler Yalnızca ChromeOS.

Giriş durumunu okumak ve izlemek için chrome.loginState API'yi kullanın.

yönetimi

chrome.management API, yüklü ve çalışan uzantıların/uygulamaların listesini yönetmenin yollarını sağlar. Bu, özellikle yerleşik Yeni Sekme sayfasını geçersiz kılan uzantılar için yararlıdır.

bildirimler

Şablonları kullanarak zengin bildirimler oluşturmak ve bu bildirimleri sistem tepsisinde kullanıcılara göstermek için chrome.notifications API'sini kullanın.

ekran dışı
Chrome 109 ve sonraki sürümler MV3 ve sonraki sürümler

Ekran dışı dokümanlar oluşturmak ve yönetmek için offscreen API'yi kullanın.

çok amaçlı adres çubuğu

Çok amaçlı adres çubuğu API'sı, Google Chrome'un çok amaçlı adres çubuğu olarak da bilinen adres çubuğuna bir anahtar kelime kaydetmenize olanak tanır.

pageCapture

Bir sekmeyi MHTML olarak kaydetmek için chrome.pageCapture API'sini kullanın.

izinler

chrome.permissions API'yi kullanarak yükleme zamanında değil çalışma zamanında Beyan edilen isteğe bağlı izinleri isteyin. Böylece kullanıcılar, izinlerin neden gerekli olduğunu anlayıp yalnızca gerekli olan izinleri verebilir.

platformKeys
Yalnızca Chrome 45 ve üstü ChromeOS

Platform tarafından yönetilen istemci sertifikalarına erişmek için chrome.platformKeys API'yi kullanın. Kullanıcı veya politika izni verirse bir uzantı, özel kimlik doğrulama protokolünde böyle bir sertifikayı kullanabilir. Örneğin bu, üçüncü taraf VPN'lerde platform tarafından yönetilen sertifikaların kullanılmasına olanak tanır (bkz. {@link vpnProvider chrome.vpnProvider}).

güç

Sistemin güç yönetimi özelliklerini geçersiz kılmak için chrome.power API'yi kullanın.

printerProvider
Chrome 44 ve sonraki sürümler

chrome.printerProvider API'si, yazdırma yöneticisi tarafından kullanılan etkinliklerin uzantılar tarafından kontrol edilen yazıcıları sorgulamasını, işlevlerini sorgulamasını ve yazdırma işlerini bu yazıcılara göndermesini sağlar.

yazdırma
Yalnızca Chrome 81 ve üstü sürümler Yalnızca ChromeOS

Yazdırma işlerini Chromebook'ta yüklü yazıcılara göndermek için chrome.printing API'sini kullanın.

printingMetrics
Chrome 79 ve sonraki sürümler Yalnızca ChromeOS Politika gerektirir

Yazdırma kullanımıyla ilgili verileri getirmek için chrome.printingMetrics API'yi kullanın.

gizlilik

Chrome'daki, kullanıcı gizliliğini etkileyebilecek özelliklerin kullanımını kontrol etmek için chrome.privacy API'yi kullanın. Bu API, Chrome'un yapılandırmasını almak ve ayarlamak için API türündeki ChromeSetting prototipini kullanır.

süreçler
Yeni geliştirilenler kanalı

Tarayıcının işlemleriyle etkileşimde bulunmak için chrome.processes API'yi kullanın.

proxy

Chrome'un proxy ayarlarını yönetmek için chrome.proxy API'yi kullanın. Bu API, proxy yapılandırmasını almak ve ayarlamak için API türündeki ChromeSetting prototipini kullanır.

readingList
Chrome 120 ve üzeri MV3 ve üzeri

Okuma Listesi'ndeki öğeleri okumak ve değiştirmek için chrome.readingList API'sini kullanın.

çalışma zamanı

Service Worker'ı almak, manifest dosyasıyla ilgili ayrıntıları döndürmek ve uzantı yaşam döngüsündeki etkinlikleri dinlemek ve yanıtlamak için chrome.runtime API'yi kullanın. Bu API'yı, URL'lerin göreli yolunu tam nitelikli URL'lere dönüştürmek için de kullanabilirsiniz.

komut dosyası oluşturma
Chrome 88 ve üstü sürümler MV3 ve sonraki sürümler

Komut dosyasını farklı bağlamlarda yürütmek için chrome.scripting API'yi kullanın.

search
Chrome 87 ve sonraki sürümler

Varsayılan sağlayıcı aracılığıyla arama yapmak için chrome.search API'yi kullanın.

oturumlar

Tarama oturumundaki sekmeleri ve pencereleri sorgulamak ve geri yüklemek için chrome.sessions API'yi kullanın.

sidePanel
Chrome 114 ve üstü sürümler MV3 ve üstü

Tarayıcının yan panelinde, bir web sayfasının ana içeriğinin yanında içerik barındırmak için chrome.sidePanel API'sini kullanın.

depolama alanı

Kullanıcı verilerini depolamak, almak ve bunlarda yapılan değişiklikleri izlemek için chrome.storage API'yi kullanın.

system.cpu

CPU meta verilerini sorgulamak için system.cpu API'yi kullanın.

system.display

Ekran meta verilerini sorgulamak için system.display API'yi kullanın.

system.memory

chrome.system.memory API.

system.storage

Çıkarılabilir depolama cihazı takılıp çıkarıldığında bildirim almak ve depolama cihazı bilgilerini sorgulamak için chrome.system.storage API'yi kullanın.

systemLog
Beklemede Yalnızca ChromeOS'te Politika gerektirir

Uzantılardan Chrome sistem günlüklerini kaydetmek için chrome.systemLog API'yi kullanın.

tabCapture

Sekme medya akışlarıyla etkileşimde bulunmak için chrome.tabCapture API'yi kullanın.

tabGroups
Chrome 89 ve sonraki sürümler MV3 ve sonraki sürümler

Tarayıcının sekme gruplandırma sistemiyle etkileşim kurmak için chrome.tabGroups API'yi kullanın. Bu API'yi tarayıcıdaki sekme gruplarını değiştirmek ve yeniden düzenlemek için kullanabilirsiniz. Sekmeleri gruplandırmak, gruplandırmayı iptal etmek veya gruplarda hangi sekmelerin olduğunu sorgulamak için chrome.tabs API'yi kullanın.

sekmeler

Tarayıcının sekme sistemiyle etkileşim kurmak için chrome.tabs API'yi kullanın. Bu API'yı tarayıcıda sekmeler oluşturmak, değiştirmek ve yeniden düzenlemek için kullanabilirsiniz.

topSites

Yeni sekme sayfasında görüntülenen en iyi sitelere (yani en çok ziyaret edilen siteler) erişmek için chrome.topSites API'sini kullanın. Kullanıcı tarafından özelleştirilmiş kısayollar buna dahil değildir.

tts

Sentezlenmiş metin okumayı (TTS) oynatmak için chrome.tts API'yi kullanın. Ayrıca, bir uzantının konuşma motoru uygulamasına olanak tanıyan ilgili {@link ttsEngine} API'sine de bakın.

ttsEngine

Uzantı kullanarak bir metin okuma(TTS) motoru uygulamak için chrome.ttsEngine API'sini kullanın. Uzantınız bu API'yi kullanarak kaydedilirse, herhangi bir uzantı veya Chrome Uygulaması konuşma oluşturmak için {@link tts} API'sini kullandığında, söylenecek sözü içeren etkinlikleri ve diğer parametreleri alır. Ardından uzantınız, konuşmayı sentezlemek, çıkarmak ve durumu bildirmek üzere etkinlikleri çağırma işlevine geri göndermek için mevcut web teknolojilerini kullanabilir.

tür

chrome.types API, Chrome için tür bildirimleri içerir.

userScripts
Chrome 120 ve üzeri MV3 ve üzeri

Kullanıcı komut dosyalarını Kullanıcı Komut Dosyaları bağlamında yürütmek için userScripts API'yi kullanın.

vpnProvider
Yalnızca Chrome 43 ve üstü ChromeOS

VPN istemcisi uygulamak için chrome.vpnProvider API'yi kullanın.

duvar kağıdı
Yalnızca Chrome 43 ve üstü ChromeOS

ChromeOS duvar kağıdını değiştirmek için chrome.wallpaper API'yi kullanın.

webAuthenticationProxy
Chrome 115 ve sonraki sürümler MV3 ve sonraki sürümler

chrome.webAuthenticationProxy API, uzak ana makine üzerinde çalışan uzaktan masaüstü yazılımlarının Web Authentication API (WebAuthn) isteklerine yerel bir istemcide işlem yapmak için müdahale etmelerini sağlar.

webNavigation

İşlem sırasındaki navigasyon isteklerinin durumu hakkında bildirim almak için chrome.webNavigation API'yi kullanın.

webRequest

Trafiği gözlemleyip analiz etmek ve yayın sırasındaki isteklere müdahale etmek, bunları engellemek veya değiştirmek için chrome.webRequest API'yi kullanın.

pencereler

Tarayıcı pencereleriyle etkileşim kurmak için chrome.windows API'yi kullanın. Bu API'yı tarayıcıda pencere oluşturmak, değiştirmek ve yeniden düzenlemek için kullanabilirsiniz.