Справочник по API

Для работы большинства расширений требуется доступ к одному или нескольким API расширений Chrome. В этом справочнике по API описываются API, доступные для использования в расширениях, и представлены примеры их использования.

ДоступностьОсобенности

Используйте API chrome.accessibilityFeatures для управления функциями доступности Chrome. Этот API использует прототип ChromeSetting для получения и настройки отдельных функций доступности. Для получения состояний функций расширение должно запросить разрешение accessibilityFeatures.read . Для изменения состояния функции расширению требуется разрешение accessibilityFeatures.modify . Обратите внимание, что разрешение accessibilityFeatures.modify не подразумевает наличие разрешения accessibilityFeatures.read .

будильники

Используйте API chrome.alarms для планирования запуска кода периодически или в определенное время в будущем.

аудио
Только Chrome OS 59+

API chrome.audio позволяет пользователям получать информацию об аудиоустройствах, подключенных к системе, и управлять ими. В настоящее время этот API доступен только в режиме киоска для ChromeOS.

закладки

Используйте API chrome.bookmarks для создания, упорядочивания и других операций с закладками. См. также раздел «Переопределение страниц» , который можно использовать для создания пользовательской страницы менеджера закладок.

браузерAction
≤ МВ2

Используйте действия браузера для размещения значков на главной панели инструментов Google Chrome справа от адресной строки. Помимо значка , действие браузера может иметь подсказку , значок и всплывающее окно .

просмотр данных

Используйте API chrome.browsingData для удаления данных о просмотре страниц из локального профиля пользователя.

поставщик сертификатов
Только ChromeOS 46+

Используйте этот API для предоставления сертификатов платформе, которая может использовать эти сертификаты для аутентификации TLS.

команды

Используйте API команд для добавления сочетаний клавиш, которые запускают действия в вашем расширении, например, действие по открытию браузера или отправке команды расширению.

КонтентНастройки

Используйте API chrome.contentSettings для изменения настроек, контролирующих использование веб-сайтами таких функций, как файлы cookie, JavaScript и плагины. В более общем смысле, настройки контента позволяют настраивать поведение Chrome для каждого сайта отдельно, а не глобально.

contextMenus

Используйте API chrome.contextMenus для добавления пунктов в контекстное меню Google Chrome. Вы можете выбрать, к каким типам объектов будут применяться дополнения в контекстном меню, например к изображениям, гиперссылкам и страницам.

печенье

Используйте API chrome.cookies для запроса и изменения файлов cookie, а также для получения уведомлений об их изменении.

отладчик

API chrome.debugger служит альтернативным транспортом для протокола удалённой отладки Chrome. Используйте chrome.debugger для подключения к одной или нескольким вкладкам для мониторинга сетевого взаимодействия, отладки JavaScript, изменения DOM и CSS и других задач. Используйте свойство tabId объекта Debuggee для выбора вкладок с помощью sendCommand и маршрутизации событий по tabId из обратных вызовов onEvent .

декларативныйКонтент

Используйте API chrome.declarativeContent для выполнения действий в зависимости от содержимого страницы, не требуя разрешения на чтение содержимого страницы.

декларативныйNetRequest
Хром 84+

API chrome.declarativeNetRequest используется для блокировки или изменения сетевых запросов путём указания декларативных правил. Это позволяет расширениям изменять сетевые запросы, не перехватывая их и не просматривая их содержимое, обеспечивая тем самым большую конфиденциальность.

декларативныйWebRequest
Бета-канал ≤ MV2

Примечание: этот API устарел. Вместо него обратитесь к API declarativeNetRequest . Используйте API chrome.declarativeWebRequest для перехвата, блокировки или изменения запросов в процессе выполнения. Он значительно быстрее API chrome.webRequest , поскольку позволяет регистрировать правила, которые обрабатываются в браузере, а не в JavaScript-движке, что сокращает задержки при передаче данных и повышает эффективность.

desktopCapture

API Desktop Capture захватывает содержимое экрана, отдельных окон или отдельных вкладок.

devtools.inspectedWindow

Используйте API chrome.devtools.inspectedWindow для взаимодействия с проверяемым окном: получите идентификатор вкладки для проверяемой страницы, оцените код в контексте проверяемого окна, перезагрузите страницу или получите список ресурсов на странице.

devtools.network

Используйте API chrome.devtools.network для получения информации о сетевых запросах, отображаемых инструментами разработчика на панели «Сеть».

devtools.panels

Используйте API chrome.devtools.panels для интеграции вашего расширения в пользовательский интерфейс окна «Инструменты разработчика»: создавайте собственные панели, получайте доступ к существующим панелям и добавляйте боковые панели.

devtools.performance
Хром 129+

Используйте API chrome.devtools.performance для прослушивания обновлений статуса записи на панели «Производительность» в DevTools.

devtools.recorder
Хром 105+

Используйте API chrome.devtools.recorder для настройки панели Recorder в DevTools.

DNS
Канал разработки

Используйте API chrome.dns для разрешения DNS.

documentScan
Только Chrome OS 44+

Используйте API chrome.documentScan для обнаружения и извлечения изображений из подключенных сканеров документов.

дом
Хром 88+

Используйте API chrome.dom для доступа к специальным API DOM для расширений.

загрузки

Используйте API chrome.downloads для программного инициирования, мониторинга, управления и поиска загрузок.

enterprise.deviceAttributes
Chrome 46+ Только ChromeOS Требуется политика

Используйте API chrome.enterprise.deviceAttributes для чтения атрибутов устройства. Примечание: этот API доступен только для расширений, принудительно установленных корпоративной политикой.

enterprise.hardwarePlatform

Используйте API chrome.enterprise.hardwarePlatform для получения информации о производителе и модели аппаратной платформы, на которой работает браузер. Примечание: этот API доступен только для расширений, установленных корпоративной политикой.

enterprise.login
Chrome 139+ Только ChromeOS Требуется политика

Используйте API chrome.enterprise.login для выхода из сеансов управляемого гостевого режима. Примечание: этот API доступен только для расширений, установленных корпоративной политикой в сеансах управляемого гостевого режима ChromeOS.

enterprise.networkingAttributes
Chrome 85+ Только ChromeOS Требуется политика

Используйте API chrome.enterprise.networkingAttributes для чтения информации о вашей текущей сети. Примечание: этот API доступен только для расширений, принудительно установленных корпоративной политикой.

enterprise.platformKeys
Только для ChromeOS Требуется политика

Используйте API chrome.enterprise.platformKeys для генерации ключей и установки сертификатов для них. Сертификаты будут управляться платформой и могут использоваться для аутентификации TLS, доступа к сети или другими расширениями через chrome.platformKeys.

события

Пространство имен chrome.events содержит общие типы, используемые API, отправляющими события, чтобы уведомить вас о чем-то интересном.

расширение

API chrome.extension содержит утилиты, которые может использовать любая страница расширения. Он включает поддержку обмена сообщениями между расширением и его скриптами контента, а также между расширениями, как подробно описано в разделе «Передача сообщений» .

Типы расширений

API chrome.extensionTypes содержит объявления типов для расширений Chrome.

fileBrowserHandler
Только ChromeOS Только передний план

Используйте API chrome.fileBrowserHandler для расширения возможностей файлового браузера Chrome OS. Например, с помощью этого API вы можете разрешить пользователям загружать файлы на ваш сайт.

fileSystemProvider
только ChromeOS

Используйте API chrome.fileSystemProvider для создания файловых систем, к которым можно получить доступ из файлового менеджера в Chrome OS.

Настройки шрифта

Используйте API chrome.fontSettings для управления настройками шрифтов Chrome.

гсм

Используйте chrome.gcm , чтобы разрешить приложениям и расширениям отправлять и получать сообщения через Firebase Cloud Messaging (FCM).

история

Используйте API chrome.history для работы с историей посещённых страниц браузера. Вы можете добавлять, удалять и запрашивать URL-адреса в истории браузера. Чтобы переопределить страницу истории своей версией, см. раздел Переопределение страниц .

i18n

Используйте инфраструктуру chrome.i18n для реализации интернационализации всего вашего приложения или расширения.

личность

Используйте API chrome.identity для получения токенов доступа OAuth2.

праздный

Используйте API chrome.idle для определения изменения состояния простоя устройства.

ввод.время
только ChromeOS

Используйте API chrome.input.ime для реализации собственного редактора метода ввода (IME) для Chrome OS. Это позволит вашему расширению обрабатывать нажатия клавиш, настраивать композицию и управлять окном-кандидатом.

идентификатор_экземпляра
Хром 44+

Используйте chrome.instanceID для доступа к службе Instance ID.

loginState
Только Chrome OS 78+

Используйте API chrome.loginState для чтения и мониторинга состояния входа.

управление

API chrome.management предоставляет способы управления установленными приложениями и расширениями.

уведомления

Используйте API chrome.notifications для создания расширенных уведомлений с использованием шаблонов и показа этих уведомлений пользователям в системном трее.

омнибокс

API омнибокса позволяет регистрировать ключевое слово в адресной строке Google Chrome, которая также известна как омнибокс.

pageAction
≤ МВ2

Используйте API chrome.pageAction для размещения значков на главной панели инструментов Google Chrome справа от адресной строки. Действия на странице — это действия, которые можно выполнить на текущей странице, но которые применимы не ко всем страницам. Неактивные действия на странице отображаются серым цветом.

pageCapture

Используйте API chrome.pageCapture для сохранения вкладки в формате MHTML.

разрешения

Используйте API chrome.permissions для запроса объявленных необязательных разрешений во время выполнения, а не во время установки, чтобы пользователи понимали, зачем нужны разрешения, и предоставляли только необходимые.

platformKeys
Только ChromeOS 45+

Используйте API chrome.platformKeys для доступа к клиентским сертификатам, управляемым платформой. Если пользователь или политика предоставляет разрешение, расширение может использовать такой сертификат в своём собственном протоколе аутентификации. Например, это позволяет использовать управляемые платформой сертификаты в сторонних VPN (см. chrome.vpnProvider ).

власть

Используйте API chrome.power для переопределения функций управления питанием системы.

поставщик принтеров
Хром 44+

API chrome.printerProvider предоставляет события, используемые диспетчером печати для запроса принтеров, управляемых расширениями, запроса их возможностей и отправки заданий печати на эти принтеры.

печать
Только Chrome OS 81+

Используйте API chrome.printing для отправки заданий печати на принтеры, установленные на Chromebook.

метрики печати
Chrome 79+ Только ChromeOS Требуется политика

Используйте API chrome.printingMetrics для получения данных об использовании печати.

конфиденциальность

Используйте API chrome.privacy для управления функциями Chrome, которые могут повлиять на конфиденциальность пользователя. Этот API использует прототип ChromeSetting для получения и настройки конфигурации Chrome.

процессы
Канал разработки

Используйте API chrome.processes для взаимодействия с процессами браузера.

прокси

Используйте API chrome.proxy для управления настройками прокси-сервера Chrome. Этот API использует прототип ChromeSetting для получения и настройки конфигурации прокси-сервера.

время выполнения

Используйте API chrome.runtime для получения сервис-воркера, возврата информации о манифесте, а также для отслеживания и реагирования на события в жизненном цикле расширения. Вы также можете использовать этот API для преобразования относительных путей URL-адресов в полные URL-адреса.

поиск
Хром 87+

Используйте API chrome.search для поиска через провайдера по умолчанию.

сеансы

Используйте API chrome.sessions для запроса и восстановления вкладок и окон из сеанса просмотра.

хранилище

Используйте API chrome.storage для хранения, извлечения и отслеживания изменений пользовательских данных.

system.cpu

Используйте API system.cpu для запроса метаданных ЦП.

система.дисплей

Используйте API system.display для запроса метаданных отображения.

системная память

API chrome.system.memory .

системное хранилище

Используйте API chrome.system.storage для запроса информации об устройстве хранения данных и получения уведомлений при подключении и отсоединении съемного устройства хранения данных.

системный журнал
Chrome 125+ Только ChromeOS Требуется политика

Используйте API chrome.systemLog для записи системных журналов Chrome из расширений.

tabCapture

Используйте API chrome.tabCapture для взаимодействия с медиапотоками вкладок.

вкладки

Используйте API chrome.tabs для взаимодействия с системой вкладок браузера. С помощью этого API можно создавать, изменять и переупорядочивать вкладки в браузере.

топСайты

Используйте API chrome.topSites для доступа к самым популярным сайтам (т. е. наиболее посещаемым), отображаемым на странице новой вкладки. В их число не входят ярлыки, настроенные пользователем.

ттс

Используйте API chrome.tts для воспроизведения синтезированной речи (TTS). См. также API ttsEngine , которое позволяет реализовать речевой движок через расширение.

ttsEngine

Используйте API chrome.ttsEngine для реализации движка преобразования текста в речь (TTS) с помощью расширения. Если ваше расширение зарегистрировано с помощью этого API, оно будет получать события, содержащие фразу для озвучивания и другие параметры, когда любое расширение или приложение Chrome использует API tts для генерации речи. Затем ваше расширение может использовать любую доступную веб-технологию для синтеза и вывода речи, а также отправлять события обратно вызывающей функции для сообщения о состоянии.

типы

API chrome.types содержит объявления типов для Chrome.

vpnProvider
Только Chrome OS 43+

Используйте API chrome.vpnProvider для реализации VPN-клиента.

обои
Только Chrome OS 43+

Используйте API chrome.wallpaper для смены обоев ChromeOS.

веб-навигация

Используйте API chrome.webNavigation для получения уведомлений о статусе навигационных запросов в процессе выполнения.

webRequest

Используйте API chrome.webRequest для наблюдения и анализа трафика, а также для перехвата, блокирования или изменения запросов в процессе их выполнения.

окна

Используйте API chrome.windows для взаимодействия с окнами браузера. С помощью этого API можно создавать, изменять и переупорядочивать окна в браузере.