Fichier manifeste des zones de stockage

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

Les règles sont semblables aux options, mais sont configurées par un administrateur système plutôt que par l'utilisateur, ce qui permet de préconfigurer l'application pour tous les utilisateurs d'une organisation. Découvrez comment Chrome gère les règles pour obtenir des exemples tirés de Chrome.

Une fois les règles déclarées, elles peuvent être lues dans l'API storage.managed. C'est à l'application d'appliquer les règles configurées par l'administrateur.

Exemple de fichier manifest.json

La propriété storage.managed_schema indique un fichier de l'application qui contient le schéma de la règle.

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

Chrome charge ensuite ces règles à partir du 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'une modification de règle est détectée, y compris lorsque le navigateur n'était pas en cours d'exécution si l'application utilise des pages d'événement. Vous pouvez vérifier les règles chargées par Chrome à l'adresse chrome://policy.

Format du schéma

Le format du schéma JSON présente des exigences supplémentaires par rapport à 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és constituent les règles de cette application.
  • Chaque schéma doit avoir une valeur $ref ou un seul 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ée 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" }
        }
      }
    }
  }
}