ストレージ領域のマニフェスト

local ストレージ領域と sync ストレージ領域とは異なり、managed ストレージ領域では構造を JSON スキーマとして宣言する必要があり、Chrome によって厳密に検証されます。このスキーマは、"storage" マニフェスト キーの "managed_schema" プロパティで指定されたファイルに保存し、アプリでサポートされているエンタープライズ ポリシーを宣言する必要があります。

ポリシーはオプションに似ていますが、ユーザーではなくシステム管理者が構成するため、組織のすべてのユーザーに対してアプリを事前構成できます。Chrome 自体の例については、Chrome がポリシーを処理する方法をご覧ください。

ポリシーを宣言すると、storage.managed API から読み取ることができます。管理者が設定したポリシーを適用するのはアプリ次第です。

manifest.json の例

storage.managed_schema プロパティは、ポリシー スキーマを含むアプリ内のファイルを示します。

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

Chrome は、基盤となるオペレーティング システムと、ログインしたユーザーの Google Apps からこれらのポリシーを読み込みます。storage.onChanged イベントは、ポリシーの変更が検出されると呼び出されます。アプリがイベントページを使用している場合は、ブラウザが実行されていない間も呼び出されます。Chrome によって読み込まれたポリシーは chrome://policy で確認できます。

スキーマ形式

JSON スキーマ形式には、Chrome からの追加要件があります。

  • 最上位スキーマの型は object にする必要があります。
  • 最上位の objectadditionalProperties は指定できません。宣言された properties は、このアプリのポリシーです。
  • 各スキーマには、$ref 値または type を 1 つ指定する必要があります。

スキーマが無効な場合、Chrome は拡張機能を読み込まず、スキーマが検証されなかった理由を表示します。ポリシー値がスキーマに準拠していない場合、storage.managed API によって公開されません。

サンプル スキーマ

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