La plupart des extensions ont besoin d'accéder à une ou plusieurs API Chrome Extensions pour fonctionner. Cette documentation de référence décrit les API disponibles pour les extensions et présente des exemples de cas d'utilisation.
Fonctionnalités communes de l'API Extensions
Une API Extensions se compose d'un espace de noms contenant des méthodes et des propriétés permettant de gérer les extensions, et généralement, mais pas toujours, des champs de fichier manifeste du fichier manifest.json
. Par exemple, l'espace de noms chrome.action
nécessite un objet "action"
dans le fichier manifeste. De nombreuses API nécessitent également des autorisations dans le fichier manifeste.
Sauf indication contraire, les méthodes des API d'extension sont asynchrones. Les méthodes asynchrones sont renvoyées immédiatement, sans attendre la fin de l'opération qui les appelle. Utilisez des promesses pour obtenir les résultats de ces méthodes. Pour en savoir plus, consultez la section Méthodes asynchrones.
API des extensions Chrome
- accessibilityFeatures
-
Utilisez l'API
chrome.accessibilityFeatures
pour gérer les fonctionnalités d'accessibilité de Chrome. Cette API s'appuie sur le prototype ChromeSetting de l'API de type pour obtenir et définir des fonctionnalités d'accessibilité individuelles. Pour obtenir les états des fonctionnalités, l'extension doit demander l'autorisationaccessibilityFeatures.read
. Pour modifier l'état des fonctionnalités, l'extension a besoin de l'autorisationaccessibilityFeatures.modify
. Notez queaccessibilityFeatures.modify
n'implique pas l'autorisationaccessibilityFeatures.read
. - action
-
Chrome 88 ou version ultérieure MV3 ou version ultérieure
Utilisez l'API
chrome.action
pour contrôler l'icône de l'extension dans la barre d'outils Google Chrome. - alarmes
-
Utilisez l'API
chrome.alarms
pour planifier l'exécution du code régulièrement ou à une heure spécifiée dans le futur. - audio
-
Chrome 59 et versions ultérieures ChromeOS uniquement
L'API
chrome.audio
permet aux utilisateurs d'obtenir des informations sur les appareils audio connectés au système et de les contrôler. Cette API n'est actuellement disponible qu'en mode Kiosque pour ChromeOS. - favoris
-
Utilisez l'API
chrome.bookmarks
pour créer, organiser et manipuler des favoris. Consultez également l'article Remplacer les pages qui vous permet de créer une page personnalisée du gestionnaire de favoris. - browsingData
-
Utilisez l'API
chrome.browsingData
pour supprimer les données de navigation du profil local d'un utilisateur. - certificateProvider
-
Chrome 46 et versions ultérieures ChromeOS uniquement
Utilisez cette API pour exposer des certificats à la plate-forme qui peut les utiliser pour les authentifications TLS.
- commandes
-
Utilisez l'API de commandes pour ajouter des raccourcis clavier qui déclenchent des actions dans votre extension (par exemple, une action permettant d'ouvrir l'action du navigateur ou d'envoyer une commande à l'extension).
- contentSettings
-
Utilisez l'API
chrome.contentSettings
pour modifier les paramètres qui déterminent si les sites Web peuvent utiliser des fonctionnalités telles que les cookies, JavaScript et les plug-ins. Plus généralement, les paramètres de contenu vous permettent de personnaliser le comportement de Chrome pour chaque site, et non pour l'ensemble. - contextMenus
-
Utilisez l'API
chrome.contextMenus
pour ajouter des éléments au menu contextuel de Google Chrome. Vous pouvez choisir les types d'objets auxquels s'appliquent les ajouts du menu contextuel, tels que des images, des liens hypertexte et des pages. - cookies
-
Utilisez l'API
chrome.cookies
pour interroger et modifier les cookies, et être averti lorsqu'ils changent. - debugger
-
L'API
chrome.debugger
sert de moyen de transport alternatif pour le protocole de débogage à distance de Chrome. Utilisezchrome.debugger
pour l'associer à un ou plusieurs onglets afin d'instrumenter les interactions réseau, de déboguer JavaScript, de modifier le DOM et le CSS, etc. Utilisez letabId
Debuggee pour cibler les onglets avec sendCommand et acheminer les événements partabId
à partir des rappels onEvent. - declarativeContent
-
Utilisez l'API
chrome.declarativeContent
pour effectuer des actions en fonction du contenu d'une page, sans avoir besoin d'être autorisé à en lire le contenu. - declarativeNetRequest
-
Chrome 84 et versions ultérieures
L'API
chrome.declarativeNetRequest
permet de bloquer ou de modifier les requêtes réseau en spécifiant des règles déclaratives. Cela permet aux extensions de modifier les requêtes réseau sans les intercepter ni consulter leur contenu, ce qui renforce la confidentialité. - desktopCapture
-
L'API Desktop Capture capture le contenu de l'écran, des fenêtres ou des onglets individuels.
- devtools.inspectedWindow
-
Utilisez l'API
chrome.devtools.inspectedWindow
pour interagir avec la fenêtre inspectée: obtenez l'ID de l'onglet de la page inspectée, évaluez le code dans le contexte de la fenêtre inspectée, actualisez la page ou obtenez la liste des ressources qu'elle contient. - devtools.network
-
Utilisez l'API
chrome.devtools.network
pour récupérer les informations sur les requêtes réseau affichées par les outils pour les développeurs dans le panneau "Network" (Réseau). - devtools.panels
-
Utilisez l'API
chrome.devtools.panels
pour intégrer votre extension dans l'interface utilisateur de la fenêtre des outils pour les développeurs: créez vos propres panneaux, accédez aux panneaux existants et ajoutez des barres latérales. - devtools.recorder
-
Chrome 105 et versions ultérieures
Utilisez l'API
chrome.devtools.recorder
pour personnaliser le panneau "Enregistreur" dans les outils de développement. - dns
-
Version en développement
Utilisez l'API
chrome.dns
pour la résolution DNS. - documentScan
-
Chrome 44 et versions ultérieures ChromeOS uniquement
Utilisez l'API
chrome.documentScan
pour découvrir et récupérer des images à partir des scanners de documents connectés. - dom
-
Chrome 88 et versions ultérieures
Utilisez l'API
chrome.dom
afin d'accéder à des API DOM spéciales pour les extensions. - téléchargements
-
Utilisez l'API
chrome.downloads
pour initier, surveiller, manipuler et rechercher des téléchargements de manière programmatique. - enterprise.deviceAttributes
-
Utilisez l'API
chrome.enterprise.deviceAttributes
pour lire les attributs de l'appareil. Remarque: Cette API n'est disponible que pour les extensions installées d'office par une règle d'entreprise. - enterprise.hardwarePlatform
-
Chrome 71 et versions ultérieures Règles requises
Utilisez l'API
chrome.enterprise.hardwarePlatform
pour obtenir le fabricant et le modèle de la plate-forme matérielle sur laquelle le navigateur s'exécute. Remarque: Cette API n'est disponible que pour les extensions installées dans le cadre d'une règle d'entreprise. - enterprise.networkingAttributes
-
Utilisez l'API
chrome.enterprise.networkingAttributes
pour lire des informations sur votre réseau actuel. Remarque: Cette API n'est disponible que pour les extensions installées d'office par une règle d'entreprise. - enterprise.platformKeys
-
ChromeOS uniquement Règle obligatoire
Utilisez l'API
chrome.enterprise.platformKeys
pour générer des clés et installer des certificats pour ces clés. Les certificats seront gérés par la plate-forme et pourront être utilisés pour l'authentification TLS, l'accès au réseau ou par toute autre extension via {@link platformKeys chrome.platformKeys}. - événements
-
L'espace de noms
chrome.events
contient des types courants utilisés par les API qui envoient des événements pour vous avertir lorsqu'il se passe quelque chose d'intéressant. - extension
-
L'API
chrome.extension
comporte des utilitaires qui peuvent être utilisés par n'importe quelle page d'extension. Elle prend en charge l'échange de messages entre une extension et ses scripts de contenu, ou entre extensions, comme décrit en détail dans la section Transmission de messages. - extensionTypes
-
L'API
chrome.extensionTypes
contient des déclarations de type pour les extensions Chrome. - fileBrowserHandler
-
ChromeOS uniquement Premier plan uniquement
Utilisez l'API
chrome.fileBrowserHandler
pour étendre l'explorateur de fichiers Chrome OS. Par exemple, vous pouvez utiliser cette API pour permettre aux utilisateurs d'importer des fichiers sur votre site Web. - fileSystemProvider
-
ChromeOS uniquement
Utilisez l'API
chrome.fileSystemProvider
pour créer des systèmes de fichiers accessibles depuis le gestionnaire de fichiers sur Chrome OS. - fontSettings
-
Utilisez l'API
chrome.fontSettings
pour gérer les paramètres de police de Chrome. - gcm
-
Utilisez
chrome.gcm
pour permettre aux applications et aux extensions d'envoyer et de recevoir des messages via Firebase Cloud Messaging (FCM). - historique
-
Utilisez l'API
chrome.history
pour interagir avec l'enregistrement des pages consultées par le navigateur. Vous pouvez ajouter des URL, en supprimer et lancer des requêtes dans l'historique du navigateur. Pour remplacer la page d'historique par votre propre version, consultez la section Remplacer les pages. - i18n
-
Utilisez l'infrastructure
chrome.i18n
pour implémenter l'internationalisation dans l'ensemble de votre application ou de votre extension. - Identité
-
Utiliser l'API
chrome.identity
pour obtenir des jetons d'accès OAuth2 - inactif
-
Utilisez l'API
chrome.idle
pour détecter tout changement d'état inactif de la machine. - input.ime
-
Utilisez l'API
chrome.input.ime
pour implémenter un IME personnalisé pour Chrome OS. Cela permet à votre extension de gérer les combinaisons de touches, de définir la composition et de gérer la fenêtre de sélection. - instanceID
-
Chrome 44 ou version ultérieure
Utilisez
chrome.instanceID
pour accéder au service d'ID d'instance. - loginState
-
Chrome 78 et versions ultérieures ChromeOS uniquement
Utilisez l'API
chrome.loginState
pour lire et surveiller l'état de la connexion. - vidéos
-
L'API
chrome.management
permet de gérer la liste des extensions/applications installées et en cours d'exécution. Elle est particulièrement utile pour les extensions qui remplacent la page "Nouvel onglet" intégrée. - notifications
-
Utilisez l'API
chrome.notifications
pour créer des notifications enrichies à l'aide de modèles et afficher ces notifications aux utilisateurs dans la barre d'état système. - hors écran
-
Chrome 109 et versions ultérieures MV3 et versions ultérieures
Utilisez l'API
offscreen
pour créer et gérer des documents hors écran. - champ polyvalent
-
L'API du champ polyvalent vous permet d'enregistrer un mot clé dans la barre d'adresse de Google Chrome, également appelée "omnibox".
- pageCapture
-
Utilisez l'API
chrome.pageCapture
pour enregistrer un onglet au format MHTML. - autorisations
-
Utilisez l'API
chrome.permissions
pour demander des autorisations facultatives déclarées au moment de l'exécution plutôt que lors de l'installation, afin que les utilisateurs comprennent pourquoi les autorisations sont nécessaires et n'accordent que celles qui sont nécessaires. - platformKeys
-
Chrome 45 et versions ultérieures ChromeOS uniquement
Utilisez l'API
chrome.platformKeys
pour accéder aux certificats client gérés par la plate-forme. Si l'utilisateur ou la règle accorde l'autorisation, une extension peut utiliser un tel certificat dans son protocole d'authentification personnalisé. Par exemple, cela permet d'utiliser des certificats gérés par la plate-forme dans des VPN tiers (voir {@link vpnProvider chrome.vpnProvider}). - puissance
-
Utilisez l'API
chrome.power
pour ignorer les fonctionnalités de gestion de l'alimentation du système. - printerProvider
-
Chrome 44 ou version ultérieure
L'API
chrome.printerProvider
expose les événements utilisés par le gestionnaire d'impression pour interroger les imprimantes contrôlées par les extensions, connaître leurs fonctionnalités et envoyer des tâches d'impression à ces imprimantes. - impression
-
Chrome 81 et versions ultérieures ChromeOS uniquement
Utilisez l'API
chrome.printing
pour envoyer des tâches d'impression aux imprimantes installées sur le Chromebook. - printingMetrics
-
Utilisez l'API
chrome.printingMetrics
pour récupérer les données sur l'utilisation de l'impression. - confidentialité
-
Utilisez l'API
chrome.privacy
pour contrôler l'utilisation des fonctionnalités de Chrome qui peuvent affecter la confidentialité des utilisateurs. Cette API s'appuie sur le prototype ChromeSetting du type d'API pour obtenir et définir la configuration de Chrome. - processus
-
Version en développement
Utilisez l'API
chrome.processes
pour interagir avec les processus du navigateur. - proxy
-
Utilisez l'API
chrome.proxy
pour gérer les paramètres proxy de Chrome. Cette API s'appuie sur le prototype ChromeSetting du type d'API pour obtenir et définir la configuration du proxy. - readingList
-
Chrome 120 et versions ultérieures MV3 et versions ultérieures
Utilisez l'API
chrome.readingList
pour lire et modifier les éléments de la liste de lecture. - runtime
-
Utilisez l'API
chrome.runtime
pour récupérer le service worker, renvoyer des informations sur le fichier manifeste, écouter les événements du cycle de vie de l'extension et y répondre. Vous pouvez également utiliser cette API pour convertir le chemin relatif d'URL en URL complètes. - l'écriture de scripts
-
Chrome 88 ou version ultérieure MV3 ou version ultérieure
Utilisez l'API
chrome.scripting
pour exécuter le script dans différents contextes. - search
-
Chrome 87 et versions ultérieures
Utilisez l'API
chrome.search
pour effectuer une recherche via le fournisseur par défaut. - sessions
-
Utilisez l'API
chrome.sessions
pour interroger et restaurer les onglets et les fenêtres d'une session de navigation. - sidePanel
-
Chrome 114 et versions ultérieures MV3 et versions ultérieures
Utilisez l'API
chrome.sidePanel
pour héberger du contenu dans le panneau latéral du navigateur, à côté du contenu principal d'une page Web. - espace de stockage
-
Utilisez l'API
chrome.storage
pour stocker, récupérer et suivre les modifications apportées aux données utilisateur. - system.cpu
-
Utiliser l'API
system.cpu
pour interroger les métadonnées du processeur - system.display
-
Utilisez l'API
system.display
pour interroger les métadonnées d'affichage. - system.memory
-
L'API
chrome.system.memory
. - system.storage
-
Utilisez l'API
chrome.system.storage
pour interroger les informations d'un périphérique de stockage et recevoir une notification lorsqu'un périphérique de stockage amovible est associé ou dissocié. - systemLog
-
Utilisez l'API
chrome.systemLog
pour enregistrer les journaux système Chrome à partir des extensions. - tabCapture
-
Utiliser l'API
chrome.tabCapture
pour interagir avec les flux multimédias des onglets - tabGroups
-
Chrome 89 ou version ultérieure MV3 ou version ultérieure
Utilisez l'API
chrome.tabGroups
pour interagir avec le système de regroupement d'onglets du navigateur. Vous pouvez utiliser cette API pour modifier et réorganiser les groupes d'onglets du navigateur. Pour regrouper et dissocier des onglets, ou pour demander quels onglets figurent dans des groupes, utilisez l'APIchrome.tabs
. - onglets
-
Utilisez l'API
chrome.tabs
pour interagir avec le système d'onglets du navigateur. Vous pouvez utiliser cette API pour créer, modifier et réorganiser des onglets dans le navigateur. - topSites
-
Utilisez l'API
chrome.topSites
pour accéder aux principaux sites (c'est-à-dire les sites les plus consultés) affichés sur la page "Nouvel onglet". Les raccourcis personnalisés par l'utilisateur ne sont pas concernés. - tts
-
Utiliser l'API
chrome.tts
pour écouter la synthèse vocale. Voir aussi l'API {@link ttsEngine} associée, qui permet à une extension d'implémenter un moteur de synthèse vocale. - ttsEngine
-
Utilisez l'API
chrome.ttsEngine
pour implémenter un moteur de synthèse vocale à l'aide d'une extension. Si votre extension s'enregistre à l'aide de cette API, elle recevra des événements contenant un énoncé à prononcer et d'autres paramètres lorsqu'une extension ou une application Chrome utilise l'API {@link tts} pour générer un discours. Votre extension peut ensuite utiliser n'importe quelle technologie Web disponible pour synthétiser et générer la voix, puis renvoyer des événements à la fonction appelante pour indiquer l'état. - de recherche
-
L'API
chrome.types
contient des déclarations de type pour Chrome. - userScripts
-
Chrome 120 et versions ultérieures MV3 et versions ultérieures
Utilisez l'API
userScripts
pour exécuter des scripts utilisateur dans le contexte des scripts utilisateur. - vpnProvider
-
Chrome 43 et versions ultérieures ChromeOS uniquement
Utilisez l'API
chrome.vpnProvider
pour implémenter un client VPN. - 3D
-
Chrome 43 et versions ultérieures ChromeOS uniquement
Utilisez l'API
chrome.wallpaper
pour modifier le fond d'écran ChromeOS. - webAuthenticationProxy
-
Chrome 115 et versions ultérieures MV3 et versions ultérieures
L'API
chrome.webAuthenticationProxy
permet aux logiciels de bureau à distance exécutés sur un hôte distant d'intercepter les requêtes de l'API Web Authentication (WebAuthn) afin de les gérer sur un client local. - webNavigation
-
Utilisez l'API
chrome.webNavigation
pour recevoir des notifications sur l'état des requêtes de navigation en cours de transfert. - webRequest
-
Utilisez l'API
chrome.webRequest
pour observer et analyser le trafic, et pour intercepter, bloquer ou modifier les requêtes en cours de transfert. - Windows
-
Utilisez l'API
chrome.windows
pour interagir avec les fenêtres du navigateur. Vous pouvez utiliser cette API pour créer, modifier et réorganiser les fenêtres du navigateur.