Dokumentacja API (original) (raw)
Manifest V3
Dokumentacja API
Większość rozszerzeń do Chrome potrzebuje dostępu do co najmniej jednego interfejsu API rozszerzeń do Chrome, aby działać. W tym dokumencie znajdziesz opis interfejsów API dostępnych do użycia w rozszerzeniach oraz przykłady przypadków użycia.
Od wersji Chrome 144 wszystkie interfejsy API rozszerzeń Chrome są też dostępne w przestrzeni nazw browser (np. browser.tabs.create({})). Jest to alias przestrzeni nazw chrome (np. chrome.tabs.create({})), który zapewnia zgodność z innymi przeglądarkami używającymi przestrzeni nazw browser w przypadku interfejsów API rozszerzeń.
Typowe funkcje interfejsu API rozszerzeń
Interfejs Extensions API składa się z przestrzeni nazw zawierającej metody i właściwości do obsługi rozszerzeń oraz zwykle, ale nie zawsze, z pól manifestu w pliku manifest.json. Na przykład przestrzeń nazw chrome.action wymaga obiektu "action" w pliku manifestu. Wiele interfejsów API wymaga też uprawnień w pliku manifestu.
Metody w interfejsach API rozszerzeń są asynchroniczne, chyba że zaznaczono inaczej. Metody asynchroniczne zwracają wartość natychmiast, bez oczekiwania na zakończenie operacji, która je wywołuje. Aby uzyskać wyniki tych metod asynchronicznych, użyj obietnic.
Interfejsy API rozszerzeń Chrome
Użyj interfejsu chrome.accessibilityFeatures API, aby zarządzać funkcjami ułatwień dostępu w Chrome. Ten interfejs API korzysta z prototypu ChromeSetting interfejsu API typu do pobierania i ustawiania poszczególnych funkcji ułatwień dostępu. Aby uzyskać stany funkcji, rozszerzenie musi poprosić o uprawnienie accessibilityFeatures.read. Aby modyfikować stan funkcji, rozszerzenie potrzebuje uprawnienia accessibilityFeatures.modify. Pamiętaj, że uprawnienie accessibilityFeatures.modify nie oznacza uprawnienia accessibilityFeatures.read.
Chrome 88 lub nowszaMV3+
Użyj interfejsu chrome.action API, aby sterować ikoną rozszerzenia na pasku narzędzi Google Chrome.
Użyj interfejsu chrome.alarms API, aby zaplanować okresowe uruchamianie kodu lub uruchamianie go w określonym czasie w przyszłości.
Chrome 59 lub nowszy Tylko ChromeOS
Interfejs chrome.audio API umożliwia użytkownikom uzyskiwanie informacji o urządzeniach audio podłączonych do systemu i sterowanie nimi. Ten interfejs API jest obecnie dostępny tylko w trybie kiosku w ChromeOS.
Użyj interfejsu chrome.bookmarks API, aby tworzyć, porządkować i w inny sposób manipulować zakładkami. Zobacz też strony zastępowania, których możesz użyć do utworzenia niestandardowej strony menedżera zakładek.
użyć interfejsu chrome.browsingData API, aby usunąć dane przeglądania z lokalnego profilu użytkownika;
Chrome 46 lub nowszy Tylko ChromeOS
Użyj tego interfejsu API, aby udostępnić platformie certyfikaty, które mogą być używane do uwierzytelniania TLS.
Użyj interfejsu Commands API, aby dodać skróty klawiszowe, które wywołują działania w rozszerzeniu, np. otwieranie działania przeglądarki lub wysyłanie polecenia do rozszerzenia.
Użyj interfejsu chrome.contentSettings API, aby zmienić ustawienia kontrolujące, czy witryny mogą korzystać z takich funkcji, jak pliki cookie, JavaScript i wtyczki. Ustawienia treści umożliwiają dostosowywanie działania Chrome w przypadku poszczególnych witryn, a nie globalnie.
Użyj interfejsu chrome.contextMenus API, aby dodać elementy do menu kontekstowego Google Chrome. Możesz wybrać typy obiektów, do których mają być stosowane dodatki do menu kontekstowego, np. obrazy, hiperlinki i strony.
Używaj interfejsu chrome.cookies API do wysyłania zapytań o pliki cookie i ich modyfikowania oraz do otrzymywania powiadomień o ich zmianach.
Interfejs chrome.debugger API służy jako alternatywny transport dla protokołu zdalnego debugowania Chrome. Użyj chrome.debugger, aby dołączyć do co najmniej 1 karty i instrumentować interakcje sieciowe, debugować JavaScript, modyfikować DOM i CSS oraz wykonywać inne czynności. Użyj właściwości Debuggee tabId, aby kierować zdarzenia na karty z wartością sendCommand i kierować zdarzenia według wartości tabId z wywołań zwrotnych onEvent.
Używaj interfejsu chrome.declarativeContent API do wykonywania działań w zależności od treści strony bez konieczności uzyskiwania uprawnień do odczytywania treści strony.
Interfejs chrome.declarativeNetRequest API służy do blokowania lub modyfikowania żądań sieciowych przez określanie reguł deklaratywnych. Dzięki temu rozszerzenia mogą modyfikować żądania sieciowe bez ich przechwytywania i wyświetlania ich zawartości, co zapewnia większą prywatność.
Interfejs Desktop Capture API przechwytuje zawartość ekranu, poszczególnych okien lub poszczególnych kart.
Użyj interfejsu chrome.devtools.inspectedWindow API, aby wchodzić w interakcje z kontrolowanym oknem: uzyskać identyfikator karty kontrolowanej strony, ocenić kod w kontekście kontrolowanego okna, ponownie załadować stronę lub uzyskać listę zasobów na stronie.
Użyj interfejsu chrome.devtools.network API, aby pobrać informacje o żądaniach sieciowych wyświetlane przez Narzędzia dla programistów w panelu Sieć.
Użyj interfejsu chrome.devtools.panels API, aby zintegrować rozszerzenie z interfejsem okna Narzędzi deweloperskich: twórz własne panele, uzyskuj dostęp do istniejących paneli i dodawaj paski boczne.
Użyj interfejsu chrome.devtools.performance API, aby nasłuchiwać aktualizacji stanu nagrywania w panelu Wydajność w Narzędziach deweloperskich.
Użyj interfejsu chrome.devtools.recorder API, aby dostosować panel Rejestratora w Narzędziach deweloperskich.
Użyj interfejsu chrome.dns API do rozpoznawania DNS.
Chrome 44 i nowsze Tylko ChromeOS
Użyj interfejsu chrome.documentScan API, aby wykrywać i pobierać obrazy z podłączonych skanerów dokumentów.
Użyj interfejsu chrome.dom API, aby uzyskać dostęp do specjalnych interfejsów DOM API dla rozszerzeń.
Użyj interfejsu chrome.downloads API, aby programowo inicjować, monitorować, modyfikować i wyszukiwać pobierane pliki.
Użyj interfejsu chrome.enterprise.deviceAttributes API, aby odczytać atrybuty urządzenia. Uwaga: ten interfejs API jest dostępny tylko dla rozszerzeń, których instalacja została wymuszona na podstawie zasad przedsiębiorstwa.
Użyj interfejsu chrome.enterprise.hardwarePlatform API, aby uzyskać informacje o producencie i modelu platformy sprzętowej, na której działa przeglądarka. Uwaga: ten interfejs API jest dostępny tylko dla rozszerzeń zainstalowanych przez zasady firmy.
Użyj interfejsu chrome.enterprise.login API, aby zakończyć zarządzane sesje gościa. Uwaga: ten interfejs API jest dostępny tylko dla rozszerzeń zainstalowanych przez zasady firmy w zarządzanych sesjach gościa w ChromeOS.
enterprise.networkingAttributes
Użyj interfejsu chrome.enterprise.networkingAttributes API, aby odczytać informacje o bieżącej sieci. Uwaga: ten interfejs API jest dostępny tylko dla rozszerzeń, których instalacja została wymuszona na podstawie zasad przedsiębiorstwa.
Użyj interfejsu chrome.enterprise.platformKeys API, aby wygenerować klucze i zainstalować certyfikaty dla tych kluczy. Certyfikaty będą zarządzane przez platformę i mogą być używane do uwierzytelniania TLS, dostępu do sieci lub przez inne rozszerzenia za pomocą interfejsu chrome.platformKeys.
Przestrzeń nazw chrome.events zawiera typowe typy używane przez interfejsy API wysyłające zdarzenia, aby powiadamiać Cię o interesujących zdarzeniach.
Interfejs chrome.extension API zawiera narzędzia, z których może korzystać każda strona rozszerzenia. Obejmuje to obsługę wymiany wiadomości między rozszerzeniem a jego skryptami dotyczącymi treści lub między rozszerzeniami, co zostało szczegółowo opisane w sekcji Przekazywanie wiadomości.
Interfejs chrome.extensionTypes API zawiera deklaracje typów dla rozszerzeń Chrome.
Tylko ChromeOS Tylko na pierwszym planie
Użyj interfejsu chrome.fileBrowserHandler API, aby rozszerzyć przeglądarkę plików w ChromeOS. Możesz na przykład użyć tego interfejsu API, aby umożliwić użytkownikom przesyłanie plików na Twoją stronę.
Użyj interfejsu chrome.fileSystemProvider API, aby utworzyć systemy plików, które będą dostępne w menedżerze plików w ChromeOS.
Użyj interfejsu chrome.fontSettings API, aby zarządzać ustawieniami czcionek w Chrome.
Użyj chrome.gcm, aby umożliwić aplikacjom i rozszerzeniom wysyłanie i odbieranie wiadomości za pomocą Komunikacji w chmurze Firebase (FCM).
Użyj interfejsu chrome.history API, aby korzystać z rejestru odwiedzonych stron w przeglądarce. Możesz dodawać i usuwać adresy URL w historii przeglądarki oraz wyszukiwać je. Aby zastąpić stronę historii własną wersją, zapoznaj się z sekcją Zastępowanie stron.
Użyj infrastruktury chrome.i18n, aby wdrożyć internacjonalizację w całej aplikacji lub rozszerzeniu.
Użyj interfejsu chrome.identity API, aby uzyskać tokeny dostępu OAuth2.
Użyj interfejsu chrome.idle API, aby wykrywać zmiany stanu bezczynności urządzenia.
Użyj interfejsu chrome.input.ime API, aby wdrożyć niestandardowy edytor IME dla ChromeOS. Dzięki temu rozszerzenie może obsługiwać naciśnięcia klawiszy, ustawiać kompozycję i zarządzać oknem sugestii.
Aby uzyskać dostęp do usługi identyfikatora instancji, użyj nazwy chrome.instanceID.
Chrome 78 lub nowszy Tylko ChromeOS
Użyj interfejsu chrome.loginState API, aby odczytywać i monitorować stan logowania.
Interfejs chrome.management API umożliwia zarządzanie zainstalowanymi aplikacjami i rozszerzeniami.
Za pomocą interfejsu chrome.notifications API możesz tworzyć rozbudowane powiadomienia przy użyciu szablonów i wyświetlać je użytkownikom w zasobniku systemowym.
Chrome 109 lub nowszyMV3 lub nowszy
Do tworzenia dokumentów poza ekranem i zarządzania nimi służy interfejs offscreen API.
Interfejs API omniboksu umożliwia zarejestrowanie słowa kluczowego na pasku adresu Google Chrome, który jest też nazywany omniboksem.
Użyj interfejsu chrome.pageCapture API, aby zapisać kartę w formacie MHTML.
Używaj interfejsu chrome.permissions API, aby prosić o zadeklarowane uprawnienia opcjonalne w czasie działania aplikacji, a nie w czasie instalacji. Dzięki temu użytkownicy będą rozumieć, dlaczego aplikacja potrzebuje tych uprawnień, i przyznawać tylko te, które są niezbędne.
Chrome 45 lub nowszy Tylko ChromeOS
Użyj interfejsu chrome.platformKeys API, aby uzyskać dostęp do certyfikatów klienta zarządzanych przez platformę. Jeśli użytkownik lub zasady przyznają uprawnienia, rozszerzenie może używać takiego certyfikatu w swoim niestandardowym protokole uwierzytelniania. Umożliwia to np. korzystanie z certyfikatów zarządzanych przez platformę w usługach VPN innych firm (patrz chrome.vpnProvider).
Użyj interfejsu chrome.power API, aby zastąpić funkcje zarządzania energią systemu.
Interfejs chrome.printerProvider API udostępnia zdarzenia używane przez menedżera drukowania do wysyłania zapytań o drukarki kontrolowane przez rozszerzenia, ich możliwości i przesyłania do nich zadań drukowania.
Chrome 81 lub nowszy Tylko ChromeOS
Użyj interfejsu chrome.printing API, aby wysyłać zadania drukowania do drukarek zainstalowanych na Chromebooku.
Użyj interfejsu chrome.printingMetrics API, aby pobrać dane o korzystaniu z drukowania.
Użyj interfejsu chrome.privacy API, aby kontrolować korzystanie z funkcji Chrome, które mogą wpływać na prywatność użytkownika. Ten interfejs API korzysta z prototypu ChromeSetting interfejsu API typu do pobierania i ustawiania konfiguracji Chrome.
Użyj interfejsu chrome.processes API, aby wchodzić w interakcje z procesami przeglądarki.
Użyj interfejsu chrome.proxy API, aby zarządzać ustawieniami serwera proxy w Chrome. Ten interfejs API korzysta z prototypu ChromeSetting interfejsu API typu do pobierania i ustawiania konfiguracji serwera proxy.
Użyj interfejsu chrome.readingList API, aby odczytywać i modyfikować elementy na liście Do przeczytania.
Użyj interfejsu API chrome.runtime, aby pobrać service workera, zwrócić szczegóły manifestu oraz nasłuchiwać zdarzeń w cyklu życia rozszerzenia i na nie odpowiadać. Możesz też użyć tego interfejsu API, aby przekonwertować ścieżkę względną adresów URL na pełne adresy URL.
Chrome 88 lub nowszaMV3+
Użyj interfejsu chrome.scripting API, aby wykonać skrypt w różnych kontekstach.
Chrome w wersji 87 lub nowszej
Użyj interfejsu chrome.search API, aby wyszukiwać za pomocą domyślnego dostawcy.
Użyj interfejsu chrome.sessions API, aby wysyłać zapytania i przywracać karty i okna z sesji przeglądania.
Chrome 114 lub nowszyMV3 lub nowszy
Użyj interfejsu chrome.sidePanel API, aby hostować treści w panelu bocznym przeglądarki obok głównej treści strony internetowej.
Użyj interfejsu chrome.storage API, aby przechowywać, pobierać i śledzić zmiany w danych użytkowników.
Użyj interfejsu system.cpu API, aby wysyłać zapytania o metadane procesora.
Użyj interfejsu system.display API, aby wysyłać zapytania o metadane wyświetlania.
Interfejs API chrome.system.memory.
Użyj interfejsu chrome.system.storage API, aby wysyłać zapytania o informacje o urządzeniu pamięci masowej i otrzymywać powiadomienia o podłączeniu i odłączeniu wymiennego urządzenia pamięci masowej.
Użyj interfejsu chrome.systemLog API, aby rejestrować logi systemowe Chrome z rozszerzeń.
Użyj interfejsu chrome.tabCapture API, aby korzystać ze strumieni multimediów na karcie.
Chrome 89 lub nowszyMV3+
Użyj interfejsu chrome.tabGroups API, aby korzystać z systemu grupowania kart w przeglądarce. Za pomocą tego interfejsu API możesz modyfikować i przenosić grupy kart w przeglądarce. Aby grupować i rozgrupowywać karty lub sprawdzać, które karty należą do grup, użyj chrome.tabs interfejsu API.
Użyj interfejsu chrome.tabs API, aby korzystać z systemu kart przeglądarki. Za pomocą tego interfejsu API możesz tworzyć, modyfikować i przenosić karty w przeglądarce.
Używaj interfejsu chrome.topSites API, aby uzyskać dostęp do najpopularniejszych stron (czyli najczęściej odwiedzanych), które są wyświetlane na stronie nowej karty. Nie obejmują one skrótów dostosowanych przez użytkownika.
Użyj interfejsu chrome.tts API, aby odtwarzać zsyntetyzowany tekst w formie mowy (TTS). Zobacz też powiązany interfejs ttsEngine API, który umożliwia rozszerzeniu wdrożenie silnika mowy.
Użyj interfejsu chrome.ttsEngine API, aby wdrożyć silnik zamiany tekstu na mowę(TTS) za pomocą rozszerzenia. Jeśli rozszerzenie zarejestruje się za pomocą tego interfejsu API, będzie otrzymywać zdarzenia zawierające wypowiedź do odczytania i inne parametry, gdy dowolne rozszerzenie lub aplikacja Chrome użyje interfejsu tts API do generowania mowy. Rozszerzenie może następnie użyć dowolnej dostępnej technologii internetowej do syntezy i odtwarzania mowy oraz wysyłania zdarzeń z powrotem do funkcji wywołującej, aby zgłosić stan.
Interfejs chrome.types API zawiera deklaracje typów dla Chrome.
Użyj interfejsu userScripts API, aby wykonywać skrypty użytkownika w kontekście skryptów użytkownika.
Chrome 43 lub nowszy Tylko ChromeOS
Użyj interfejsu chrome.vpnProvider API, aby wdrożyć klienta VPN.
Chrome 43 lub nowszy Tylko ChromeOS
Użyj interfejsu chrome.wallpaper API, aby zmienić tapetę w ChromeOS.
Chrome 115 lub nowszyMV3 lub nowszy
Interfejs chrome.webAuthenticationProxy API umożliwia oprogramowaniu pulpitu zdalnego działającemu na hoście zdalnym przechwytywanie żądań do interfejsu Web Authentication API (WebAuthn) w celu obsługi ich na kliencie lokalnym.
Używaj interfejsu chrome.webNavigation API, aby otrzymywać powiadomienia o stanie żądań nawigacyjnych w trakcie lotu.
Użyj interfejsu chrome.webRequest API, aby obserwować i analizować ruch oraz przechwytywać, blokować lub modyfikować żądania w trakcie przesyłania.
Używaj interfejsu chrome.windows API do interakcji z oknami przeglądarki. Za pomocą tego interfejsu API możesz tworzyć, modyfikować i przekształcać okna w przeglądarce.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-12-11 UTC.