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型にする必要があります。 - トップレベルの
objectにadditionalPropertiesを含めることはできません。宣言されたpropertiesは、このアプリのポリシーです。 - 各スキーマには、
$ref値または 1 つのtypeのいずれかが必要です。
スキーマが無効な場合、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" }
}
}
}
}
}