Description
Utilisez l'API chrome.contentSettings pour modifier les paramètres qui déterminent si les sites Web peuvent utiliser des fonctionnalités telles que des cookies, du code JavaScript et des plug-ins. Plus généralement, les paramètres de contenu vous permettent de personnaliser le comportement de Chrome pour chaque site, au lieu de le faire de manière globale.
Autorisations
contentSettingsPour utiliser l'API, vous devez déclarer l'autorisation "contentSettings" dans le fichier manifeste de votre extension. Exemple :
{ "name": "My extension", ... "permissions": [ "contentSettings" ], ... } Concepts et utilisation
Schémas de paramètres de contenu
Vous pouvez utiliser des modèles pour spécifier les sites Web concernés par chaque paramètre de contenu. Par exemple, https://*.youtube.com/* spécifie youtube.com et tous ses sous-domaines. La syntaxe des modèles de paramètres de contenu est la même que celle des modèles de correspondance, à quelques différences près :
- Pour les URL
http,httpsetftp, le chemin d'accès doit être un caractère générique (/*). Pour les URLfile, le chemin d'accès doit être entièrement spécifié et ne doit pas contenir de caractères génériques. - Contrairement aux modèles de correspondance, les modèles de paramètres de contenu peuvent spécifier un numéro de port. Si un numéro de port est spécifié, le modèle ne correspond qu'aux sites Web utilisant ce port. Si aucun numéro de port n'est spécifié, le modèle correspond à tous les ports.
Priorité des schémas
Lorsqu'une règle de paramètre de contenu s'applique à un site donné, celle dont le modèle est le plus spécifique prévaut.
Par exemple, les modèles suivants sont classés par ordre de priorité :
https://www.example.com/*https://*.example.com/*(correspond à example.com et à tous les sous-domaines)<all_urls>(correspond à toutes les URL)
Trois types de caractères génériques affectent la spécificité d'un modèle :
- Caractères génériques dans le port (par exemple,
https://www.example.com:*/*) - Caractères génériques dans le schéma (par exemple,
*://www.example.com:123/*) - Caractères génériques dans le nom d'hôte (par exemple,
https://*.example.com:123/*)
Si un modèle est plus spécifique qu'un autre dans une partie, mais moins spécifique dans une autre, les différentes parties sont vérifiées dans l'ordre suivant : nom d'hôte, schéma, port. Par exemple, les modèles suivants sont classés par ordre de priorité :
https://www.example.com:*/*Spécifie le nom d'hôte et le schéma.*:/www.example.com:123/*Pas aussi élevé, car bien qu'il spécifie le nom d'hôte, il ne spécifie pas le schéma.https://*.example.com:123/*Inférieur, car bien qu'il spécifie le port et le schéma, il comporte un caractère générique dans le nom d'hôte.
Schémas principaux et secondaires
L'URL prise en compte pour déterminer le paramètre de contenu à appliquer dépend du type de contenu. Par exemple, les paramètres de contentSettings.notifications sont basés sur l'URL affichée dans l'omnibox. Cette URL est appelée URL "principale".
Certains types de contenus peuvent prendre en compte des URL supplémentaires. Par exemple, la décision d'autoriser ou non un site à définir un contentSettings.cookies est prise en fonction de l'URL de la requête HTTP (qui est l'URL principale dans ce cas) ainsi que de l'URL affichée dans l'omnibox (appelée URL "secondaire").
Si plusieurs règles comportent des modèles principaux et secondaires, celle dont le modèle principal est le plus spécifique prévaut. Si plusieurs règles ont le même modèle principal, celle dont le modèle secondaire est le plus spécifique est prioritaire. Par exemple, la liste suivante de paires de modèles principaux/secondaires est classée par ordre de priorité :
| Priorité | Modèle principal | Motif secondaire |
|---|---|---|
| 1 | https://www.moose.com/*, | https://www.wombat.com/* |
| 2 | https://www.moose.com/*, | <all_urls> |
| 3 | <all_urls>, | https://www.wombat.com/* |
| 4 | <all_urls>, | <all_urls> |
Les modèles secondaires ne sont pas acceptés pour le paramètre de contenu des images.
Identifiants de ressources
Les identifiants de ressources vous permettent de spécifier des paramètres de contenu pour des sous-types spécifiques d'un type de contenu. Actuellement, le seul type de contenu qui accepte les identifiants de ressources est contentSettings.plugins, où un identifiant de ressource identifie un plug-in spécifique. Lorsque vous appliquez des paramètres de contenu, les paramètres du plug-in spécifique sont vérifiés en premier. Si aucun paramètre n'est trouvé pour le plug-in spécifique, les paramètres de contenu généraux pour les plug-ins sont vérifiés.
Par exemple, si une règle de paramètre de contenu a l'identifiant de ressource adobe-flash-player et le modèle <all_urls>, elle prévaut sur une règle sans identifiant de ressource et avec le modèle https://www.example.com/*, même si ce modèle est plus spécifique.
Vous pouvez obtenir la liste des identifiants de ressources pour un type de contenu en appelant la méthode contentSettings.ContentSetting.getResourceIdentifiers(). La liste renvoyée peut changer en fonction de l'ensemble des plug-ins installés sur l'ordinateur de l'utilisateur, mais Chrome essaie de conserver des identifiants stables lors des mises à jour des plug-ins.
Exemples
Pour essayer cette API, installez l'exemple d'API contentSettings à partir du dépôt chrome-extension-samples.
Types
AutoVerifyContentSetting
Énumération
"allow"
"block"
CameraContentSetting
Énumération
"allow"
"block"
"ask"
ClipboardContentSetting
Énumération
"allow"
"block"
"ask"
ContentSetting
Propriétés
- effacer
vide
Efface toutes les règles de paramètre de contenu définies par cette extension.
La fonction
clearse présente comme suit :(details: object) => {...}
- détails
objet
- champ d'application
Champ d'application facultatif
Où effacer le paramètre (par défaut : normal).
-
- Renvoie
Promise<void>
Chrome 96 et versions ultérieures
-
- get
vide
Obtient le paramètre de contenu actuel pour une paire d'URL donnée.
La fonction
getse présente comme suit :(details: object) => {...}
- détails
objet
- navigation privée
booléen facultatif
Indique si les paramètres de contenu doivent être vérifiés pour une session de navigation privée. (false par défaut)
- primaryUrl
chaîne
URL principale pour laquelle le paramètre de contenu doit être récupéré. Notez que la signification d'une URL principale dépend du type de contenu.
- resourceIdentifier
ResourceIdentifier facultatif
Identifiant plus spécifique du type de contenu pour lequel les paramètres doivent être récupérés.
- secondaryUrl
chaîne facultative
URL secondaire pour laquelle le paramètre de contenu doit être récupéré. La valeur par défaut est l'URL principale. Notez que la signification d'une URL secondaire dépend du type de contenu. Tous les types de contenu n'utilisent pas d'URL secondaires.
-
- Renvoie
Promise<object>
Chrome 96 et versions ultérieures
-
- getResourceIdentifiers
vide
La fonction
getResourceIdentifiersse présente comme suit :() => {...}- Renvoie
Promise<ResourceIdentifier[]>
Chrome 96 et versions ultérieures
-
- set
vide
Applique une nouvelle règle de paramètre de contenu.
La fonction
setse présente comme suit :(details: object) => {...}
- détails
objet
- primaryPattern
chaîne
Format de l'URL principale. Pour en savoir plus sur le format d'un modèle, consultez Modèles de paramètres de contenu.
- resourceIdentifier
ResourceIdentifier facultatif
Identifiant de ressource pour le type de contenu.
- champ d'application
Champ d'application facultatif
Où définir le paramètre (par défaut : normal).
- secondaryPattern
chaîne facultative
Format de l'URL secondaire. Par défaut, toutes les URL sont mises en correspondance. Pour en savoir plus sur le format d'un modèle, consultez Modèles de paramètres de contenu.
- Paramètre
tous
Paramètre appliqué par cette règle. Consultez la description des objets ContentSetting individuels pour connaître les valeurs possibles.
-
- Renvoie
Promise<void>
Chrome 96 et versions ultérieures
-
CookiesContentSetting
Énumération
"allow"
"block"
"session_only"
FullscreenContentSetting
Valeur
"allow"
ImagesContentSetting
Énumération
"allow"
"block"
JavascriptContentSetting
Énumération
"allow"
"block"
LocationContentSetting
Énumération
"allow"
"block"
"ask"
MicrophoneContentSetting
Énumération
"allow"
"block"
"ask"
MouselockContentSetting
Valeur
"allow"
MultipleAutomaticDownloadsContentSetting
Énumération
"allow"
"block"
"ask"
NotificationsContentSetting
Énumération
"allow"
"block"
"ask"
PluginsContentSetting
Valeur
"block"
PopupsContentSetting
Énumération
"allow"
"block"
PpapiBrokerContentSetting
Valeur
"block"
ResourceIdentifier
Le seul type de contenu utilisant des identifiants de ressources est contentSettings.plugins. Pour en savoir plus, consultez Identifiants de ressources.
Propriétés
- description
chaîne facultative
Description lisible de la ressource.
- id
chaîne
Identifiant de ressource pour le type de contenu donné.
Scope
Champ d'application de ContentSetting. L'une des options suivantes : regular (paramètre pour le profil standard, hérité par le profil de navigation privée s'il n'est pas remplacé ailleurs), incognito\_session\_only (paramètre pour le profil de navigation privée, qui ne peut être défini que pendant une session de navigation privée et est supprimé à la fin de la session, remplaçant les paramètres standards).
Énumération
"regular"
"incognito_session_only"
Propriétés
automaticDownloads
Indique si les sites sont autorisés à télécharger automatiquement plusieurs fichiers. Une des valeurs suivantes : allow (Autoriser les sites à télécharger automatiquement plusieurs fichiers), block (Ne pas autoriser les sites à télécharger automatiquement plusieurs fichiers) ou ask (Demander lorsqu'un site souhaite télécharger automatiquement des fichiers après le premier fichier). La valeur par défaut est ask. L'URL principale est celle du frame de premier niveau. L'URL secondaire n'est pas utilisée.
autoVerify
Indique si les sites sont autorisés à utiliser l'API Private State Tokens. L'une des options suivantes : allow (Autoriser les sites à utiliser l'API Private State Tokens) ou block (Empêcher les sites d'utiliser l'API Private State Tokens). La valeur par défaut est allow. Lorsque vous appelez set(), le format d'URL principal doit être <all_urls>. L'URL secondaire n'est pas utilisée.
camera
Indique si les sites sont autorisés à accéder à l'appareil photo. allow : autoriser les sites à accéder à la caméra, block : ne pas autoriser les sites à accéder à la caméra, ask : demander l'autorisation lorsqu'un site souhaite accéder à la caméra. La valeur par défaut est ask. L'URL principale est celle du document qui a demandé l'accès à la caméra. L'URL secondaire n'est pas utilisée. REMARQUE : Le paramètre "allow" n'est pas valide si les deux modèles sont "<all_urls>".
clipboard
Autoriser ou non les sites à accéder au presse-papiers via les fonctionnalités avancées de l'API Async Clipboard. Les fonctionnalités "avancées" incluent tout ce qui n'est pas l'écriture de formats intégrés après un geste de l'utilisateur, c'est-à-dire la capacité de lire, d'écrire des formats personnalisés et d'écrire sans geste de l'utilisateur. L'une des options suivantes : allow : autoriser les sites à utiliser les fonctionnalités avancées du presse-papiers, block : ne pas autoriser les sites à utiliser les fonctionnalités avancées du presse-papiers, ask : demander l'autorisation lorsqu'un site souhaite utiliser les fonctionnalités avancées du presse-papiers. La valeur par défaut est ask. L'URL principale est celle du document qui a demandé l'accès au presse-papiers. L'URL secondaire n'est pas utilisée.
cookies
Indique si les sites Web sont autorisés à définir des cookies et d'autres données locales. L'une des valeurs suivantes : allow : accepter les cookies, block : bloquer les cookies, session\_only : accepter les cookies uniquement pour la session en cours. La valeur par défaut est allow. L'URL principale est celle qui représente l'origine du cookie. L'URL secondaire est celle du cadre de premier niveau.
fullscreen
Obsolète. N'a plus aucun effet. L'autorisation de plein écran est désormais accordée automatiquement pour tous les sites. La valeur est toujours allow.
images
Indique si les images doivent être affichées. L'une des options suivantes : allow : afficher les images, block : ne pas afficher les images. La valeur par défaut est allow. L'URL principale est celle du frame de premier niveau. L'URL secondaire est l'URL de l'image.
javascript
Indique s'il faut exécuter JavaScript. allow : exécutez JavaScript. block : n'exécutez pas JavaScript. La valeur par défaut est allow. L'URL principale est celle du frame de premier niveau. L'URL secondaire n'est pas utilisée.
location
Indique si la géolocalisation doit être autorisée. allow : autoriser les sites à suivre votre position physique, block : interdire aux sites de suivre votre position physique, ask : demander avant d'autoriser les sites à suivre votre position physique. La valeur par défaut est ask. L'URL principale est celle du document qui a demandé les données de localisation. L'URL secondaire est l'URL du frame de niveau supérieur (qui peut être différente ou non de l'URL de la requête).
microphone
Indique si les sites sont autorisés à accéder au micro. L'une des options suivantes : allow : autoriser les sites à accéder au micro, block : ne pas autoriser les sites à accéder au micro, ask : demander l'autorisation lorsqu'un site souhaite accéder au micro. La valeur par défaut est ask. L'URL principale est celle du document qui a demandé l'accès au micro. L'URL secondaire n'est pas utilisée. REMARQUE : Le paramètre "allow" n'est pas valide si les deux modèles sont "<all_urls>".
mouselock
Obsolète. N'a plus aucun effet. L'autorisation de verrouillage de la souris est désormais accordée automatiquement pour tous les sites. La valeur est toujours allow.
notifications
Indique si les sites sont autorisés à afficher des notifications sur le bureau. L'une des valeurs suivantes : allow : autoriser les sites à afficher des notifications sur le bureau, block : ne pas autoriser les sites à afficher des notifications sur le bureau, ask : demander confirmation lorsqu'un site souhaite afficher des notifications sur le bureau. La valeur par défaut est ask. L'URL principale est celle du document qui souhaite afficher la notification. L'URL secondaire n'est pas utilisée.
plugins
Obsolète. La compatibilité avec Flash ayant été supprimée dans Chrome 88, cette autorisation n'a plus aucun effet. La valeur est toujours block. Les appels à set() et clear() seront ignorés.
popups
Indique si les sites sont autorisés à afficher des pop-up. Une des options suivantes : allow : autoriser les sites à afficher des pop-up, block : ne pas autoriser les sites à afficher des pop-up. La valeur par défaut est block. L'URL principale est celle du frame de premier niveau. L'URL secondaire n'est pas utilisée.
unsandboxedPlugins
Obsolète. Auparavant, cette règle permettait de contrôler si les sites étaient autorisés à exécuter des plug-ins non mis en bac à sable. Toutefois, le processus de broker Flash ayant été supprimé dans Chrome 88, cette autorisation n'a plus aucun effet. La valeur est toujours block. Les appels à set() et clear() seront ignorés.