Fichier manifeste des zones de stockage

Contrairement aux zones de stockage local et sync, la zone de stockage managed nécessite que sa structure soit déclaré en tant que schéma JSON et est strictement validé par Chrome. Ce schéma doit être stocké dans un indiqué par la propriété "managed_schema" de la clé du fichier manifeste "storage" et déclare le règles d'entreprise compatibles avec l'extension.

Les stratégies sont semblables aux options mais elles sont configurées par un administrateur système et non par l'utilisateur, permettant à l'extension d'être préconfigurée pour tous les utilisateurs d'une organisation. Découvrez comment Chrome gère pour voir des exemples provenant de Chrome.

Une fois les règles déclarées, vous pouvez les lire à partir de l'API storage.managed. C'est à vous pour appliquer les règles configurées par l'administrateur.

Exemple de fichier manifest.json

La propriété storage.managed_schema indique un fichier dans l'extension qui contient la règle du schéma.

{
  "name": "My enterprise extension",
  "storage": {
    "managed_schema": "schema.json"
  },
  ...
}

Chrome charge ensuite ces règles depuis le système d'exploitation sous-jacent et depuis Google Apps pour les utilisateurs connectés. L'événement storage.onChanged est déclenché chaque fois qu'un changement de stratégie est détecté. y compris lorsque le navigateur n'était pas en cours d'exécution, si l'extension utilise des pages d'événements. Vous pouvez vérifier les règles chargées par Chrome sur la page chrome://policy.

Format du schéma

Le format du schéma JSON présente des exigences supplémentaires de la part de Chrome:

  • Le schéma de premier niveau doit être de type object.
  • L'élément object de premier niveau ne peut pas contenir additionalProperties. Les properties déclarées sont les pour cette extension.
  • Chaque schéma doit avoir une valeur $ref ou exactement un type.

Si le schéma n'est pas valide, Chrome ne charge pas l'extension et indique la raison pour laquelle le schéma n'a pas été validé. Si une valeur de règle n'est pas conforme au schéma, elle ne sera pas publiées par l'API storage.managed.

Schéma d'exemple

{
  "type": "object",

  // "properties" maps an optional key of this object to its schema. At the
  // top-level object, these keys are the policy names supported.
  "properties": {

    // The policy name "AutoSave" is mapped to its schema, which in this case
    // declares it as a simple boolean value.
    // "title" and "description" are optional and are used to show a
    // user-friendly name and documentation to the administrator.
    "AutoSave": {
      "title": "Automatically save changes.",
      "description": "If set to true then changes will be automatically saved.",
      "type": "boolean"
    },

    // Other simple types supported include "integer", "string" and "number".
    "PollRefreshRate": {
      "type": "integer"
    },

    "DefaultServiceUrl": {
      "type": "string"
    },

    // "array" is a list of items that conform to another schema, described
    // in "items". An example to this schema is [ "one", "two" ].
    "ServiceUrls": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },

    // A more complex example that describes a list of bookmarks. Each bookmark
    // has a "title", and can have a "url" or a list of "children" bookmarks.
    // The "id" attribute is used to name a schema, and other schemas can reuse
    // it using the "$ref" attribute.
    "Bookmarks": {
      "type": "array",
      "id": "ListOfBookmarks",
      "items": {
        "type": "object",
        "properties": {
          "title": { "type": "string" },
          "url": { "type": "string" },
          "children": { "$ref": "ListOfBookmarks" }
        }
      }
    },

    // An "object" can have known properties listed as "properties", and can
    // optionally have "additionalProperties" indicating a schema to apply to
    // keys that aren't found in "properties".
    // This example policy could map a URL to its settings. An example value:
    // {
    //   "youtube.com": {
    //     "blocklisted": true
    //   },
    //   "google.com": {
    //     "bypass_proxy": true
    //   }
    // }
    "SettingsForUrls": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "blocklisted": { "type": "boolean" },
          "bypass_proxy": { "type": "boolean" }
        }
      }
    }
  }
}