Manifest voor opslagruimtes

In tegenstelling tot de local en sync opslaggebieden vereist het managed opslaggebied dat de structuur ervan wordt gedeclareerd als JSON Schema en wordt deze strikt gevalideerd door Chrome. Dit schema moet worden opgeslagen in een bestand dat wordt aangegeven door de eigenschap "managed_schema" van de manifestsleutel "storage" en declareert het bedrijfsbeleid dat door de extensie wordt ondersteund.

Beleid is analoog aan opties, maar wordt geconfigureerd door een systeembeheerder in plaats van door de gebruiker, waardoor de extensie vooraf kan worden geconfigureerd voor alle gebruikers van een organisatie. Bekijk hoe Chrome omgaat met beleid voor voorbeelden van Chrome zelf.

Nadat het beleid is gedeclareerd, kan het worden gelezen vanuit de storage.managed API. Het is aan de extensie om het beleid af te dwingen dat door de beheerder is geconfigureerd.

Voorbeeld van manifest.json

De eigenschap storage.managed_schema geeft een bestand binnen de extensie aan dat het beleidsschema bevat.

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

Chrome laadt dit beleid vervolgens vanuit het onderliggende besturingssysteem en vanuit Google Apps voor ingelogde gebruikers. De gebeurtenis storage.onChanged wordt geactiveerd wanneer er een beleidswijziging wordt gedetecteerd, ook als de browser niet actief is als de extensie gebeurtenispagina's gebruikt. U kunt het beleid dat Chrome heeft geladen verifiëren op chrome://policy .

Schema-indeling

Het JSON Schema-formaat heeft enkele aanvullende vereisten vanuit Chrome:

  • Het schema op het hoogste niveau moet het type object hebben.
  • Het object op het hoogste niveau mag geen additionalProperties hebben. De aangegeven properties vormen het beleid voor deze uitbreiding.
  • Elk schema moet een $ref waarde hebben of precies één type .

Als het schema ongeldig is, laadt Chrome de extensie niet en geeft het de reden aan waarom het schema niet is gevalideerd. Als een beleidswaarde niet voldoet aan het schema, wordt deze niet gepubliceerd door de storage.managed API.

Voorbeeldschema

{
  "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" }
        }
      }
    }
  }
}