La mayoría de las extensiones necesitan acceso a una o más APIs de Chrome Extensions para funcionar. En esta referencia de API, se describen las APIs disponibles para usarlos en extensiones y presenta ejemplos de casos de uso.
Funciones comunes de la API de Extensions
Una API de extensiones consta de un espacio de nombres que contiene métodos y propiedades para hacer que las extensiones funcionen y, por lo general, pero no siempre, campos de manifiesto para el archivo manifest.json. Por ejemplo, el espacio de nombres chrome.action requiere un objeto "action"
en el manifiesto. Muchas APIs también requieren permisos en el manifiesto.
Los métodos en las APIs de extensión son asíncronos, a menos que se indique lo contrario. Los métodos asíncronos se devuelven de inmediato, sin esperar. para que finalice la operación. Usa promises para obtener los resultados de estos métodos asíncronos.
APIs de Chrome Extension
- accessibilityFeatures
-
Usa la API de
chrome.accessibilityFeaturespara administrar las funciones de accesibilidad de Chrome. Esta API se basa en el prototipo ChromeSetting de la API de tipo para obtener y configurar funciones de accesibilidad individuales. Para obtener estados de componentes, la extensión debe solicitar el permisoaccessibilityFeatures.read. Para modificar el estado de la función, la extensión necesita el permisoaccessibilityFeatures.modify. Ten en cuenta queaccessibilityFeatures.modifyno implica el permisoaccessibilityFeatures.read. - acción
-
Chrome 88 y versiones posteriores MV3+
Usa la API de
chrome.actionpara controlar el ícono de la extensión en la barra de herramientas de Google Chrome. - alarmas
-
Usa la API de
chrome.alarmspara programar el código para que se ejecute de forma periódica o en un momento específico en el futuro. - audio
-
Chrome 59 y versiones posteriores Solo en ChromeOS
La API de
chrome.audiose proporciona para permitir que los usuarios obtengan información sobre los dispositivos de audio conectados al sistema y los controlen. Actualmente, esta API solo está disponible en el modo kiosco para ChromeOS. - favoritos
-
Usa la API de
chrome.bookmarkspara crear, organizar y manipular favoritos. Consulta también Anulaciones de páginas, que puedes usar para crear una página personalizada del Administrador de favoritos. - browsingData
-
Usa la API de
chrome.browsingDatapara quitar los datos de navegación del perfil local de un usuario. - certificateProvider
-
Chrome 46 y versiones posteriores Solo en ChromeOS
Usa esta API para exponer certificados a la plataforma que puede usarlos para las autenticaciones TLS.
- comandos
-
Usa la API de comandos para agregar combinaciones de teclas que activen acciones en tu extensión, por ejemplo, una acción para abrir la acción del navegador o enviar un comando a la extensión.
- contentSettings
-
Usa la API de
chrome.contentSettingspara cambiar la configuración que controla si los sitios web pueden usar funciones como cookies, JavaScript y complementos. En términos más generales, la configuración de contenido te permite personalizar el comportamiento de Chrome para cada sitio en lugar de hacerlo de manera global. - contextMenus
-
Usa la API de
chrome.contextMenuspara agregar elementos al menú contextual de Google Chrome. Puedes elegir a qué tipos de objetos se aplican las opciones que agregues al menú contextual, como imágenes, hipervínculos y páginas. - cookies
-
Usa la API de
chrome.cookiespara consultar y modificar las cookies, y recibir notificaciones cuando cambien. - depurador
-
La API de
chrome.debuggerfunciona como un transporte alternativo para el protocolo de depuración remota de Chrome. Usachrome.debuggerpara adjuntarlo a una o más pestañas a fin de instrumentar la interacción de red, depurar JavaScript, mutar el DOM y la CSS, y mucho más. Usa la propiedadtabIddeDebuggeepara segmentar las pestañas consendCommandy los eventos de ruta portabIda partir de devoluciones de llamada deonEvent. - declarativeContent
-
Usa la API de
chrome.declarativeContentpara realizar acciones según el contenido de una página, sin necesidad de permiso para leerlo. - declarativeNetRequest
-
Chrome 84 y versiones posteriores
La API de
chrome.declarativeNetRequestse usa para bloquear o modificar solicitudes de red mediante la especificación de reglas declarativas. Esto permite que las extensiones modifiquen las solicitudes de red sin interceptarlas ni ver su contenido, lo que proporciona más privacidad. - desktopCapture
-
La API de Desktop Capture captura el contenido de la pantalla, ventanas individuales o pestañas individuales.
- devtools.inspectedWindow
-
Usa la API de
chrome.devtools.inspectedWindowpara interactuar con la ventana inspeccionada: obtén el ID de la pestaña de la página inspeccionada, evalúa el código en el contexto de la ventana inspeccionada, vuelve a cargar la página o obtén la lista de recursos dentro de la página. - devtools.network
-
Usa la API de
chrome.devtools.networkpara recuperar la información sobre las solicitudes de red que muestran las herramientas para desarrolladores en el panel Red. - devtools.panels
-
Usa la API de
chrome.devtools.panelspara integrar tu extensión en la IU de la ventana de Herramientas para desarrolladores: crea tus propios paneles, accede a paneles existentes y agrega barras laterales. - devtools.performance
-
Chrome 129 y versiones posteriores
Usa la API de
chrome.devtools.performancepara escuchar las actualizaciones de estado de grabación en el panel Rendimiento de DevTools. - devtools.recorder
-
Chrome 105 y versiones posteriores
Usa la API de
chrome.devtools.recorderpara personalizar el panel de la grabadora en Herramientas para desarrolladores. - dns
-
Canal para desarrolladores
Usa la API de
chrome.dnspara la resolución de DNS. - documentScan
-
Chrome 44 y versiones posteriores Solo para ChromeOS
Usa la API de
chrome.documentScanpara descubrir y recuperar imágenes de los escáneres de documentos adjuntos. - dom
-
Chrome 88 y versiones posteriores
Usa la API de
chrome.dompara acceder a APIs especiales del DOM para extensiones - descargas
-
Usa la API de
chrome.downloadspara iniciar, supervisar, manipular y buscar descargas de manera programática. - enterprise.deviceAttributes
-
Usa la API de
chrome.enterprise.deviceAttributespara leer los atributos del dispositivo. Nota: Esta API solo está disponible para extensiones instaladas de manera automática por la política empresarial. - enterprise.hardwarePlatform
-
Chrome 71 y versiones posteriores Requiere política
Usa la API de
chrome.enterprise.hardwarePlatformpara obtener el fabricante y el modelo de la plataforma de hardware en la que se ejecuta el navegador. Nota: Esta API solo está disponible para extensiones instaladas por una política empresarial. - enterprise.networkingAttributes
-
Usa la API de
chrome.enterprise.networkingAttributespara leer información sobre tu red actual. Nota: Esta API solo está disponible para las extensiones que la política empresarial instala de manera automática. - enterprise.platformKeys
-
Solo para ChromeOS Requiere una política
Usa la API de
chrome.enterprise.platformKeyspara generar claves y, luego, instalar certificados para ellas. La plataforma administrará los certificados y se podrán usar para la autenticación de TLS, el acceso a la red o por otra extensión a través de chrome.platformKeys. - eventos
-
El espacio de nombres
chrome.eventscontiene tipos comunes que usan las APIs para enviar eventos y notificarte cuando ocurre algo interesante. - extensión
-
La API de
chrome.extensiontiene utilidades que puede usar cualquier página de extensión. Incluye compatibilidad para intercambiar mensajes entre una extensión y sus secuencias de comandos de contenido o entre extensiones, como se describe en detalle en Transferencia de mensajes. - extensionTypes
-
La API de
chrome.extensionTypescontiene declaraciones de tipo para las extensiones de Chrome. - fileBrowserHandler
-
Solo para ChromeOS Solo en primer plano
Usa la API de
chrome.fileBrowserHandlerpara extender el navegador de archivos del Sistema operativo Chrome. Por ejemplo, puedes usar esta API para permitir que los usuarios suban archivos a tu sitio web. - fileSystemProvider
-
Solo en ChromeOS
Usa la API de
chrome.fileSystemProviderpara crear sistemas de archivos, a los que se puede acceder desde el administrador de archivos en ChromeOS. - fontSettings
-
Usa la API de
chrome.fontSettingspara administrar la configuración de la fuente de Chrome. - gcm
-
Usa
chrome.gcmpara habilitar apps y extensiones a fin de enviar y recibir mensajes a través de Firebase Cloud Messaging (FCM). - historia
-
Usa la API de
chrome.historypara interactuar con el registro de las páginas visitadas del navegador. Puedes agregar, quitar y consultar las URL en el historial del navegador. Para anular la página de historial con tu propia versión, consulta Cómo anular páginas. - i18n
-
Usa la infraestructura de
chrome.i18npara implementar la internacionalización en toda tu app o extensión. - identidad
-
Usa la API de
chrome.identitypara obtener tokens de acceso de OAuth2. - inactivo
-
Usa la API de
chrome.idlepara detectar cuándo cambia el estado de inactividad de la máquina. - input.ime
-
Solo para ChromeOS
Usa la API de
chrome.input.imepara implementar un IME personalizado para ChromeOS. Esto permite que tu extensión controle las pulsaciones de teclas, establezca la composición y administre la ventana candidata. - instanceID
-
Chrome 44 y versiones posteriores
Usa
chrome.instanceIDpara acceder al servicio Instance ID. - loginState
-
Chrome 78 y versiones posteriores Solo para ChromeOS
Usa la API de
chrome.loginStatepara leer y supervisar el estado de acceso. - de videos
-
La API de
chrome.managementproporciona formas de administrar las apps y extensiones instaladas. - notificaciones
-
Usa la API de
chrome.notificationspara crear notificaciones enriquecidas con plantillas y mostrarlas a los usuarios en la bandeja del sistema. - fuera de la pantalla
-
Chrome 109 y versiones posteriores MV3+
Usa la API de
offscreenpara crear y administrar documentos fuera de la pantalla. - Cuadro multifunción
-
La API de la barra multifunción te permite registrar una palabra clave con la barra de direcciones de Google Chrome, que también se conoce como barra multifunción.
- pageCapture
-
Usa la API de
chrome.pageCapturepara guardar una pestaña como MHTML. - permisos
-
Usa la API de
chrome.permissionspara solicitar permisos opcionales declarados durante el tiempo de ejecución en lugar de la instalación, de modo que los usuarios comprendan por qué los permisos son necesarios y otorguen solo los necesarios. - platformKeys
-
Chrome 45 y versiones posteriores Solo para ChromeOS
Usa la API de
chrome.platformKeyspara acceder a los certificados de cliente administrados por la plataforma. Si el usuario o la política otorgan el permiso, una extensión puede usar ese certificado en su protocolo de autenticación personalizado. Por ejemplo, esto permite el uso de certificados administrados por la plataforma en VPN de terceros (consulta chrome.vpnProvider). - encendido
-
Usa la API de
chrome.powerpara anular las funciones de administración de batería del sistema. - printerProvider
-
Chrome 44 y versiones posteriores
La API de
chrome.printerProviderexpone los eventos que usa el administrador de impresión para consultar impresoras controladas por extensiones, consultar sus capacidades y enviar trabajos de impresión a estas impresoras. - impresión
-
Chrome 81 y versiones posteriores Solo en ChromeOS
Usa la API de
chrome.printingpara enviar trabajos de impresión a las impresoras instaladas en la Chromebook. - printingMetrics
-
Usa la API de
chrome.printingMetricspara recuperar datos sobre el uso de impresiones. - privacidad
-
Usa la API de
chrome.privacypara controlar el uso de las funciones de Chrome que pueden afectar la privacidad del usuario. Esta API se basa en el prototipo de ChromeSetting del tipo de API para obtener y establecer la configuración de Chrome. - procesos
-
Canal para desarrolladores
Usa la API de
chrome.processespara interactuar con los procesos del navegador. - proxy
-
Usa la API de
chrome.proxypara administrar la configuración de proxy de Chrome. Esta API se basa en el prototipo ChromeSetting de la API de tipo para obtener y configurar la configuración del proxy. - readingList
-
Chrome 120 y versiones posteriores MV3 y versiones posteriores
Usa la API de
chrome.readingListpara leer los elementos de la Lista de lectura y modificarlos. - runtime
-
Usa la API de
chrome.runtimepara recuperar el service worker, mostrar detalles sobre el manifiesto, y detectar eventos en el ciclo de vida de la extensión y responder a ellos. También puedes usar esta API para convertir la ruta de acceso relativa de las URLs en URLs completas. - secuencias de comandos
-
Chrome 88 y versiones posteriores MV3 y versiones posteriores
Usa la API de
chrome.scriptingpara ejecutar la secuencia de comandos en diferentes contextos. - search
-
Chrome 87 y versiones posteriores
Usa la API de
chrome.searchpara realizar búsquedas a través del proveedor predeterminado. - sesiones
-
Usa la API de
chrome.sessionspara consultar y restablecer pestañas y ventanas de una sesión de navegación. - sidePanel
-
Chrome 114 y versiones posteriores MV3+
Usa la API de
chrome.sidePanelpara alojar contenido en el panel lateral del navegador junto con el contenido principal de una página web. - almacenamiento
-
Usa la API de
chrome.storagepara almacenar, recuperar y realizar un seguimiento de los cambios en los datos del usuario. - system.cpu
-
Usa la API de
system.cpupara consultar los metadatos de la CPU. - system.display
-
Usa la API de
system.displaypara consultar los metadatos de la pantalla. - system.memory
-
La API de
chrome.system.memory - system.storage
-
Usa la API de
chrome.system.storagepara consultar información del dispositivo de almacenamiento y recibir notificaciones cuando se conecte y desconecte un dispositivo de almacenamiento extraíble. - systemLog
-
Usa la API de
chrome.systemLogpara registrar los registros del sistema de Chrome desde las extensiones. - tabCapture
-
Usa la API de
chrome.tabCapturepara interactuar con las transmisiones multimedia de la pestaña. - tabGroups
-
Chrome 89 y versiones posteriores MV3 y versiones posteriores
Usa la API de
chrome.tabGroupspara interactuar con el sistema de agrupación de pestañas del navegador. Puedes usar esta API para modificar y reorganizar grupos de pestañas en el navegador. Para agrupar y desagrupar pestañas, o consultar qué pestañas están en grupos, usa la API dechrome.tabs. - pestañas
-
Usa la API de
chrome.tabspara interactuar con el sistema de pestañas del navegador. Puedes usar esta API para crear, modificar y reorganizar pestañas en el navegador. - topSites
-
Usa la API de
chrome.topSitespara acceder a los sitios principales (es decir, los sitios más visitados) que se muestran en la página de pestañas nuevas. Estas no incluyen combinaciones de teclas personalizadas por el usuario. - tts
-
Usa la API de
chrome.ttspara reproducir texto a voz (TTS) sintetizado. Consulta también la API dettsEnginerelacionada, que permite que una extensión implemente un motor de voz. - ttsEngine
-
Usa la API de
chrome.ttsEnginepara implementar un motor de texto a voz(TTS) con una extensión. Si tu extensión se registra con esta API, recibirá eventos que contengan una frase que se hablará y otros parámetros cuando cualquier extensión o app de Chrome use la API dettspara generar voz. Luego, tu extensión puede usar cualquier tecnología web disponible para sintetizar y entregar la voz, y enviar eventos a la función de llamada para informar el estado. - tipos
-
La API de
chrome.typescontiene declaraciones de tipo para Chrome. - userScripts
-
Chrome 120 y versiones posteriores MV3+
Usa la API de
userScriptspara ejecutar secuencias de comandos de usuario en el contexto de secuencias de comandos de usuario. - vpnProvider
-
Chrome 43 y versiones posteriores Solo en ChromeOS
Usa la API de
chrome.vpnProviderpara implementar un cliente de VPN. - 3D
-
Chrome 43 y versiones posteriores Solo en ChromeOS
Usa la API de
chrome.wallpaperpara cambiar el fondo de pantalla de ChromeOS. - webAuthenticationProxy
-
Chrome 115 y versiones posteriores MV3+
La API de
chrome.webAuthenticationProxypermite que el software de escritorio remoto que se ejecuta en un host remoto intercepte las solicitudes de la API de Web Authentication (WebAuthn) para controlarlas en un cliente local. - webNavigation
-
Usa la API de
chrome.webNavigationpara recibir notificaciones sobre el estado de las solicitudes de navegación en curso. - webRequest
-
Usa la API de
chrome.webRequestpara observar y analizar el tráfico, y para interceptar, bloquear o modificar solicitudes en tránsito. - windows
-
Usa la API de
chrome.windowspara interactuar con las ventanas del navegador. Puedes usar esta API para crear, modificar y reorganizar ventanas en el navegador.