Эта страница переведена с помощью Cloud Translation API.

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

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

доступностьОсобенности: Используйте API chrome.accessibilityFeatures для управления функциями доступности Chrome. Этот API использует прототип ChromeSetting типа API для получения и настройки отдельных функций доступности. Чтобы получить состояния функций, расширение должно запросить разрешение accessibilityFeatures.read . Для изменения состояния функций расширению необходимо разрешение accessibilityFeatures.modify . Обратите внимание, что accessibilityFeatures.modify не подразумевает разрешение accessibilityFeatures.read .
будильники: Используйте API chrome.alarms для планирования запуска кода периодически или в указанное время в будущем.
аудио: Chrome 59+ только ChromeOS
API chrome.audio предоставляется для того, чтобы пользователи могли получать информацию и управлять аудиоустройствами, подключенными к системе. В настоящее время этот API доступен только в режиме киоска для ChromeOS.
закладки: Используйте API chrome.bookmarks для создания, организации и других манипуляций с закладками. Также см. Override Pages , который можно использовать для создания пользовательской страницы Bookmark Manager.
браузерДействие: ≤ МВ2
Используйте действия браузера, чтобы поместить значки на главную панель инструментов Google Chrome справа от адресной строки. В дополнение к своему значку , действие браузера может иметь подсказку , значок и всплывающее окно .
просмотрДанные: Используйте API chrome.browsingData для удаления данных о просмотре из локального профиля пользователя.
CertificateProvider: Chrome 46+ только ChromeOS
Используйте этот API для предоставления сертификатов платформе, которая может использовать эти сертификаты для аутентификации TLS.
команды: Используйте API команд для добавления сочетаний клавиш, которые запускают действия в вашем расширении, например, действие по открытию браузера или отправке команды расширению.
contentНастройки: Используйте API chrome.contentSettings для изменения настроек, которые контролируют, могут ли веб-сайты использовать такие функции, как файлы cookie, JavaScript и плагины. Говоря более обобщенно, настройки контента позволяют вам настраивать поведение Chrome на основе каждого сайта, а не глобально.
контекстМеню: Используйте API chrome.contextMenus для добавления элементов в контекстное меню Google Chrome. Вы можете выбрать, к каким типам объектов будут применяться дополнения к контекстному меню, например, к изображениям, гиперссылкам и страницам.
куки: Используйте API chrome.cookies для запроса и изменения файлов cookie, а также для получения уведомлений об их изменении.
отладчик: API chrome.debugger служит альтернативным транспортом для протокола удаленной отладки Chrome. Используйте chrome.debugger для присоединения к одной или нескольким вкладкам для инструментирования сетевого взаимодействия, отладки JavaScript, мутации DOM и CSS и многого другого. Используйте свойство Debuggee tabId для нацеливания вкладок с помощью 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.сеть: Используйте API chrome.devtools.network для получения информации о сетевых запросах, отображаемых инструментами разработчика на панели «Сеть».
devtools.панели: Используйте API chrome.devtools.panels для интеграции вашего расширения в пользовательский интерфейс окна «Инструменты разработчика»: создавайте собственные панели, получайте доступ к существующим панелям и добавляйте боковые панели.
devtools.производительность: Хром 129+
Используйте API chrome.devtools.performance для прослушивания обновлений статуса записи на панели «Производительность» в DevTools.
devtools.recorder: Хром 105+
Используйте API chrome.devtools.recorder для настройки панели Recorder в DevTools.
днс: Канал разработки
Используйте API chrome.dns для разрешения DNS.
documentScan: Chrome 44+ только ChromeOS
Используйте API chrome.documentScan для обнаружения и извлечения изображений из подключенных сканеров документов.
дом: Хром 88+
Используйте API chrome.dom для доступа к специальным API DOM для расширений
загрузки: Используйте API chrome.downloads для программного инициирования, мониторинга, управления и поиска загрузок.
enterprise.deviceАтрибуты: Chrome 46+ Только ChromeOS Требуется политика
Используйте API chrome.enterprise.deviceAttributes для чтения атрибутов устройства. Примечание: этот API доступен только для расширений, принудительно установленных политикой предприятия.
enterprise.hardwarePlatform: Chrome 71+ Требуется политика
Используйте API chrome.enterprise.hardwarePlatform для получения производителя и модели аппаратной платформы, на которой работает браузер. Примечание: этот API доступен только для расширений, установленных корпоративной политикой.
предприятие.логин: Ожидается только ChromeOS Требуется политика
Используйте API chrome.enterprise.login для выхода из сеансов Managed Guest. Примечание: этот API доступен только для расширений, установленных корпоративной политикой в сеансах ChromeOS Managed Guest.
enterprise.networkingАтрибуты: 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.
ФайлБраузерХандлер: Только 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-адреса в истории браузера. Чтобы переопределить страницу истории своей собственной версией, см. Переопределение страниц .
и18н: Используйте инфраструктуру chrome.i18n для реализации интернационализации всего вашего приложения или расширения.
личность: Используйте API chrome.identity для получения токенов доступа OAuth2.
праздный: Используйте API chrome.idle для определения изменения состояния простоя устройства.
ввод.время: только ChromeOS
Используйте API chrome.input.ime для реализации пользовательского IME для Chrome OS. Это позволяет вашему расширению обрабатывать нажатия клавиш, устанавливать композицию и управлять окном-кандидатом.
экземплярID: Хром 44+
Используйте chrome.instanceID для доступа к службе Instance ID.
loginState: Chrome 78+ только ChromeOS
Используйте API chrome.loginState для чтения и мониторинга состояния входа.
управление: API chrome.management предоставляет способы управления установленными приложениями и расширениями.
уведомления: Используйте API chrome.notifications для создания расширенных уведомлений с использованием шаблонов и показа этих уведомлений пользователям в системном трее.
омнибокс: API омнибокса позволяет регистрировать ключевое слово в адресной строке Google Chrome, которая также известна как омнибокс.
страницаДействие: ≤ МВ2
Используйте API chrome.pageAction для размещения значков на главной панели инструментов Google Chrome справа от адресной строки. Действия страницы представляют собой действия, которые можно выполнить на текущей странице, но которые не применимы ко всем страницам. Действия страницы отображаются серыми, когда неактивны.
pageCapture: Используйте API chrome.pageCapture для сохранения вкладки в формате MHTML.
разрешения: Используйте API chrome.permissions для запроса объявленных необязательных разрешений во время выполнения, а не во время установки, чтобы пользователи понимали, зачем нужны разрешения, и предоставляли только те, которые необходимы.
platformKeys: Chrome 45+ только ChromeOS
Используйте API chrome.platformKeys для доступа к клиентским сертификатам, управляемым платформой. Если пользователь или политика предоставляет разрешение, расширение может использовать такой сертификат в своем пользовательском протоколе аутентификации. Например, это позволяет использовать управляемые платформой сертификаты в сторонних VPN (см. chrome.vpnProvider ).
власть: Используйте API chrome.power для переопределения функций управления питанием системы.
принтерПровайдер: Хром 44+
API chrome.printerProvider предоставляет события, используемые диспетчером печати для запроса принтеров, контролируемых расширениями, для запроса их возможностей и отправки заданий печати на эти принтеры.
печать: Chrome 81+ только ChromeOS
Используйте API chrome.printing для отправки заданий печати на принтеры, установленные на Chromebook.
печатьМетрики: Chrome 79+ Только ChromeOS Требуется политика
Используйте API chrome.printingMetrics для получения данных об использовании печати.
конфиденциальность: Используйте API chrome.privacy для управления использованием функций Chrome, которые могут повлиять на конфиденциальность пользователя. Этот API опирается на прототип ChromeSetting API типа для получения и установки конфигурации Chrome.
процессы: Канал разработки
Используйте API chrome.processes для взаимодействия с процессами браузера.
прокси: Используйте API chrome.proxy для управления настройками прокси-сервера Chrome. Этот API опирается на прототип ChromeSetting API типа для получения и установки конфигурации прокси-сервера.
время выполнения: Используйте API chrome.runtime для извлечения service worker, возврата сведений о манифесте, а также для прослушивания и реагирования на события в жизненном цикле расширения. Вы также можете использовать этот API для преобразования относительного пути URL-адресов в полностью определенные URL-адреса.
поиск: Хром 87+
Используйте API chrome.search для поиска через поставщика по умолчанию.
сеансы: Используйте API chrome.sessions для запроса и восстановления вкладок и окон из сеанса просмотра.
хранилище: Используйте API chrome.storage для хранения, извлечения и отслеживания изменений пользовательских данных.
система.cpu: Используйте API system.cpu для запроса метаданных ЦП.
система.дисплей: Используйте API system.display для запроса метаданных отображения.
системная.память: API chrome.system.memory .
системное.хранение: Используйте API chrome.system.storage для запроса информации об устройстве хранения данных и получения уведомлений при подключении и отсоединении съемного устройства хранения данных.
системный журнал: Chrome 125+ Только ChromeOS Требуется политика
Используйте API chrome.systemLog для записи системных журналов Chrome из расширений.
вкладкаЗахват: Используйте 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.
vpnПровайдер: Chrome 43+ только ChromeOS
Используйте API chrome.vpnProvider для реализации VPN-клиента.
обои: Chrome 43+ только ChromeOS
Используйте API chrome.wallpaper для смены обоев ChromeOS.
веб-навигация: Используйте API chrome.webNavigation для получения уведомлений о статусе навигационных запросов в процессе выполнения.
веб-запрос: Используйте API chrome.webRequest для наблюдения и анализа трафика, а также для перехвата, блокировки или изменения запросов в процессе выполнения.
окна: Используйте API chrome.windows для взаимодействия с окнами браузера. Вы можете использовать этот API для создания, изменения и переупорядочивания окон в браузере.