chrome.contentSettings

Descripción

Permisos

Debes declarar el permiso "contentSettings" en el manifiesto de tu extensión para usar la API. Por ejemplo:

{
  "name": "My extension",
  ...
  "permissions": [
    "contentSettings"
  ],
  ...
}

Conceptos y uso

Patrones de configuración de contenido

Puedes usar patrones para especificar los sitios web que afecta cada parámetro de configuración de contenido. Por ejemplo, https://*.youtube.com/* especifica youtube.com y todos sus subdominios. La sintaxis de los patrones de configuración de contenido es la misma que la de los patrones de coincidencia, con algunas diferencias:

• En el caso de las URLs de http, https y ftp, la ruta debe ser un comodín (/*). En el caso de las URLs de file, la ruta debe especificarse por completo y no debe contener comodines.
• A diferencia de los patrones de coincidencia, los patrones de configuración de contenido pueden especificar un número de puerto. Si se especifica un número de puerto, el patrón solo coincide con los sitios web que tienen ese puerto. Si no se especifica ningún número de puerto, el patrón coincide con todos los puertos.

Precedencia de patrones

Cuando se aplica más de una regla de configuración de contenido a un sitio determinado, prevalece la regla con el patrón más específico.

Por ejemplo, los siguientes patrones se ordenan por prioridad:

1. https://www.example.com/*
2. https://*.example.com/* (coincide con example.com y todos los subdominios)
3. <all_urls> (coincide con todas las URLs)

Hay tres tipos de comodines que afectan la especificidad de un patrón:

• Comodines en el puerto (por ejemplo, https://www.example.com:*/*)
• Comodines en el esquema (por ejemplo, *://www.example.com:123/*)
• Comodines en el nombre de host (por ejemplo, https://*.example.com:123/*)

Si un patrón es más específico que otro en una parte, pero menos específico en otra, las diferentes partes se verifican en el siguiente orden: nombre de host, esquema y puerto. Por ejemplo, los siguientes patrones se ordenan por prioridad:

1. https://www.example.com:*/* Especifica el nombre de host y el esquema.
2. *:/www.example.com:123/* No es tan alta, ya que, si bien especifica el nombre de host, no especifica el esquema.
3. https://*.example.com:123/* Es más baja porque, aunque especifica el puerto y el esquema, tiene un comodín en el nombre de host.

Patrones principales y secundarios

La URL que se tiene en cuenta cuando se decide qué parámetro de configuración de contenido aplicar depende del tipo de contenido. Por ejemplo, la configuración de contentSettings.notifications se basa en la URL que se muestra en la barra de direcciones. Esta URL se denomina "principal".

Algunos tipos de contenido pueden tener en cuenta URLs adicionales. Por ejemplo, si un sitio puede establecer un contentSettings.cookies se decide en función de la URL de la solicitud HTTP (que es la URL principal en este caso) y la URL que se muestra en el cuadro multifunción (que se denomina URL "secundaria").

Si varias reglas tienen patrones principales y secundarios, la regla con el patrón principal más específico tiene prioridad. Si varias reglas tienen el mismo patrón principal, prevalece la regla con el patrón secundario más específico. Por ejemplo, la siguiente lista de pares de patrones primarios y secundarios está ordenada por prioridad:

No se admiten patrones secundarios para el parámetro de configuración de contenido de imágenes.

Identificadores de recursos

Los identificadores de recursos te permiten especificar la configuración del contenido para subtipos específicos de un tipo de contenido. Actualmente, el único tipo de contenido que admite identificadores de recursos es contentSettings.plugins, en el que un identificador de recursos identifica un complemento específico. Cuando se aplican los parámetros de configuración del contenido, primero se verifican los parámetros de configuración del complemento específico. Si no se encuentra ningún parámetro de configuración para el complemento específico, se verifican los parámetros de configuración generales del contenido para los complementos.

Por ejemplo, si una regla de configuración de contenido tiene el identificador de recurso adobe-flash-player y el patrón <all_urls>, tendrá prioridad sobre una regla sin identificador de recurso y el patrón https://www.example.com/*, incluso si ese patrón es más específico.

Puedes obtener una lista de identificadores de recursos para un tipo de contenido llamando al método contentSettings.ContentSetting.getResourceIdentifiers(). La lista que se devuelve puede cambiar con el conjunto de complementos instalados en la máquina del usuario, pero Chrome intenta mantener los identificadores estables en las actualizaciones de complementos.

Ejemplos

Para probar esta API, instala el ejemplo de la API de contentSettings desde el repositorio de chrome-extension-samples.