La mayoría de las extensiones necesitan acceso a una o más APIs de extensiones de Chrome 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 Extensions consiste en un espacio de nombres que contiene métodos y propiedades para hacer que las extensiones funcionen, y por lo general, pero no
siempre, los campos del 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. Para obtener más información, consulta Métodos asíncronos.
APIs de extensiones de Chrome
- accessibilityFeatures
-
Usa la API de
chrome.accessibilityFeatures
para administrar las funciones de accesibilidad de Chrome. Esta API se basa en el prototipo de ChromeSetting del tipo de API para obtener y configurar funciones de accesibilidad individuales. Para obtener estados de la función, 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.modify
no implica el permisoaccessibilityFeatures.read
. - acción
-
Chrome 88 y versiones posteriores MV3+ .
Usa la API de
chrome.action
para controlar el ícono de la extensión en la barra de herramientas de Google Chrome. - alarmas
-
Usa la API de
chrome.alarms
para programar que el código se ejecute de forma periódica o a una hora específica en el futuro. - audio
-
Chrome 59 y versiones posteriores Solo en ChromeOS .
Se proporciona la API de
chrome.audio
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 modo kiosco para ChromeOS. - favoritos
-
Usa la API de
chrome.bookmarks
para crear, organizar y manipular favoritos. Consulta también Anular páginas, que puedes usar para crear una página personalizada del Administrador de favoritos. - browsingData
-
Usa la API de
chrome.browsingData
para 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.contentSettings
para 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.contextMenus
para agregar elementos al menú contextual de Google Chrome. Puedes elegir a qué tipos de objetos se aplicarán los elementos que agregues al menú contextual, como imágenes, hipervínculos y páginas. - cookies
-
Usa la API de
chrome.cookies
para consultar y modificar cookies, y recibir notificaciones cuando estas cambien. - depurador
-
La API de
chrome.debugger
funciona como un transporte alternativo para el protocolo de depuración remota de Chrome. Usachrome.debugger
para 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 propiedadtabId
deDebuggee
para segmentar las pestañas consendCommand
y los eventos de ruta portabId
a partir de devoluciones de llamada deonEvent
. - declarativeContent
-
Usa la API de
chrome.declarativeContent
para realizar acciones según el contenido de una página, sin requerir permiso para leer el contenido de la página. - declarativeNetRequest
-
Chrome 84 y versiones posteriores
La API de
chrome.declarativeNetRequest
se usa para bloquear o modificar las 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.inspectedWindow
para interactuar con la ventana inspeccionada: obtén el ID de 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 bien obtén la lista de recursos dentro de la página. - devtools.network
-
Usa la API de
chrome.devtools.network
para 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.panels
para integrar tu extensión en la IU de la ventana de las Herramientas para desarrolladores: crea tus propios paneles, accede a los paneles existentes y agrega barras laterales. - devtools.performance
-
Pendiente
Usa la API de
chrome.devtools.performance
para escuchar las actualizaciones de estado de grabación en el panel Performance en las Herramientas para desarrolladores. - devtools.recorder
-
Chrome 105 y versiones posteriores
Usa la API de
chrome.devtools.recorder
para personalizar el panel de la grabadora en Herramientas para desarrolladores. - dns
-
Canal para desarrolladores
Usa la API de
chrome.dns
para la resolución de DNS. - documentScan
-
Chrome 44 y versiones posteriores Solo en ChromeOS .
Usa la API de
chrome.documentScan
para descubrir y recuperar imágenes de los escáneres de documentos adjuntos. - dom
-
Chrome 88 y versiones posteriores
Usa la API de
chrome.dom
para acceder a APIs especiales del DOM para extensiones - descargas
-
Usa la API de
chrome.downloads
para iniciar, supervisar, manipular y buscar descargas de manera programática. - enterprise.deviceAttributes
-
Usa la API de
chrome.enterprise.deviceAttributes
para 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.hardwarePlatform
para 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.networkingAttributes
para leer información sobre tu red actual. Nota: Esta API solo está disponible para extensiones instaladas de manera automática por la política empresarial. - enterprise.platformKeys
-
Solo en ChromeOS Requiere política .
Usa la API de
chrome.enterprise.platformKeys
para generar claves y, luego, instalar certificados para ellas. La plataforma administrará los certificados, que se pueden usar para la autenticación TLS, el acceso a la red o cualquier otra extensión a través de chrome.platformKeys. - eventos
-
El espacio de nombres
chrome.events
contiene tipos comunes que usan las APIs que envían eventos para notificarte cuando sucede algo interesante. - extensión
-
La API de
chrome.extension
tiene 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.extensionTypes
contiene declaraciones de tipo para las extensiones de Chrome. - fileBrowserHandler
-
Solo en ChromeOS Solo en primer plano .
Usa la API de
chrome.fileBrowserHandler
para 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.fileSystemProvider
para crear sistemas de archivos, a los que se puede acceder desde el administrador de archivos en ChromeOS. - fontSettings
-
Usa la API de
chrome.fontSettings
para administrar la configuración de fuentes de Chrome. - gcm
-
Usa
chrome.gcm
para 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.history
para 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 del historial con tu propia versión, consulta Anular páginas. - i18n
-
Usa la infraestructura de
chrome.i18n
para implementar la internacionalización en toda tu app o extensión. - identidad
-
Usa la API de
chrome.identity
para obtener tokens de acceso de OAuth2. - inactivo
-
Usa la API de
chrome.idle
para detectar cuándo cambia el estado de inactividad de la máquina. - input.ime
-
Solo en ChromeOS
Usa la API de
chrome.input.ime
para 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.instanceID
para acceder al servicio Instance ID. - loginState
-
Chrome 78 y versiones posteriores Solo en ChromeOS .
Usa la API de
chrome.loginState
para leer y supervisar el estado de acceso. - de videos
-
La API de
chrome.management
proporciona formas de administrar las apps y extensiones instaladas. - notificaciones
-
Usa la API de
chrome.notifications
para crear notificaciones enriquecidas mediante plantillas y muéstralas a los usuarios en la bandeja del sistema. - fuera de pantalla
-
Chrome 109 y versiones posteriores MV3+ .
Usa la API de
offscreen
para crear y administrar documentos fuera de pantalla. - cuadro multifunción
-
La API del cuadro multifunción te permite registrar una palabra clave con la barra de direcciones de Google Chrome, que también se conoce como cuadro multifunción.
- pageCapture
-
Usa la API de
chrome.pageCapture
para guardar una pestaña como MHTML. - permisos
-
Usa la API de
chrome.permissions
para 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 en ChromeOS .
Usa la API de
chrome.platformKeys
para 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. P.ej., esto permite el uso de certificados administrados por la plataforma en VPN de terceros (consulta chrome.vpnProvider). - energía
-
Usa la API de
chrome.power
para anular las funciones de administración de batería del sistema. - printerProvider
-
Chrome 44 y versiones posteriores
La API de
chrome.printerProvider
expone 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.printing
para enviar trabajos de impresión a las impresoras instaladas en la Chromebook. - printingMetrics
-
Usa la API de
chrome.printingMetrics
para recuperar datos sobre el uso de impresiones. - privacidad
-
Usa la API de
chrome.privacy
para 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.processes
para interactuar con los procesos del navegador. - proxy
-
Usa la API de
chrome.proxy
para administrar la configuración de proxy de Chrome. Esta API se basa en el prototipo de ChromeSetting del tipo de API para obtener y establecer la configuración del proxy. - readingList
-
Chrome 120 y versiones posteriores MV3+ .
Usa la API de
chrome.readingList
para leer los elementos de la Lista de lectura y modificarlos. - runtime
-
Usa la API de
chrome.runtime
para 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 completamente calificadas. - secuencias de comandos
-
Chrome 88 y versiones posteriores MV3+ .
Usa la API de
chrome.scripting
para ejecutar una secuencia de comandos en diferentes contextos. - search
-
Chrome 87 y versiones posteriores
Usa la API de
chrome.search
para realizar búsquedas mediante el proveedor predeterminado. - sesiones
-
Usa la API de
chrome.sessions
para 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.sidePanel
para alojar contenido en el panel lateral del navegador junto con el contenido principal de una página web. - almacenamiento
-
Usa la API de
chrome.storage
para almacenar, recuperar y realizar un seguimiento de los cambios en los datos del usuario. - system.cpu
-
Usa la API de
system.cpu
para consultar los metadatos de la CPU. - system.display
-
Usa la API de
system.display
para consultar metadatos de visualización. - system.memory
-
La API de
chrome.system.memory
- system.storage
-
Usa la API de
chrome.system.storage
para 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.systemLog
para registrar los registros del sistema Chrome de las extensiones. - tabCapture
-
Usa la API de
chrome.tabCapture
para interactuar con las transmisiones de contenido multimedia de las pestañas. - tabGroups
-
Chrome 89 y versiones posteriores MV3+ .
Usa la API de
chrome.tabGroups
para 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.tabs
para 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.topSites
para acceder a los sitios principales (es decir, los más visitados) que se muestran en la página Nueva pestaña. Estas no incluyen combinaciones de teclas personalizadas por el usuario. - tts
-
Usa la API de
chrome.tts
para reproducir texto a voz sintetizado (TTS). Consulta también la API dettsEngine
relacionada, que permite que una extensión implemente un motor de voz. - ttsEngine
-
Usa la API de
chrome.ttsEngine
para 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 detts
para generar voz. Luego, la extensión puede usar cualquier tecnología web disponible para sintetizar y emitir la voz, y enviar eventos a la función de llamada para informar el estado. - tipos
-
La API de
chrome.types
contiene declaraciones de tipo para Chrome. - userScripts
-
Chrome 120 y versiones posteriores MV3+ .
Usa la API de
userScripts
para 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.vpnProvider
para implementar un cliente de VPN. - 3D
-
Chrome 43 y versiones posteriores Solo en ChromeOS .
Usa la API de
chrome.wallpaper
para cambiar el fondo de pantalla de ChromeOS. - webAuthenticationProxy
-
Chrome 115 y versiones posteriores MV3+ .
La API de
chrome.webAuthenticationProxy
permite 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.webNavigation
para recibir notificaciones sobre el estado de las solicitudes de navegación en tránsito. - webRequest
-
Usa la API de
chrome.webRequest
para observar y analizar el tráfico, y para interceptar, bloquear o modificar solicitudes en tránsito. - ventanas
-
Usa la API de
chrome.windows
para interactuar con las ventanas del navegador. Puedes usar esta API para crear, modificar y reorganizar ventanas en el navegador.