Схемы политик

Политики Chrome представлены в виде схем политик с помощью API службы схем. Каждая схема политики имеет уникальное имя для ее идентификации, определение полей настроек и их типов, а также удобочитаемое описание настроек на английском языке.

Например, ниже показано, как API службы схемы представляет параметр, позволяющий кнопке выхода появиться на панели задач Chrome. Упрощенным представлением этого параметра будет bool showLogoutButtonInTray . Нажмите «Показать пример» ниже, чтобы увидеть, как API службы схемы представляет этот параметр.

Показать пример

{
  "name": "customers/C0202nabg/policySchemas/chrome.users.ShowLogoutButton",
  "policyDescription": "Show logout button in tray.", // description of the policy
  "definition": { // definition of the settings (fields names and types)
    "messageType": [
      {
        "name": "ShowLogoutButton",
        "field": [
          {
            "name": "showLogoutButtonInTray", // the setting showLogoutButtonInTray
            "number": 1,
            "label": "LABEL_OPTIONAL",
            "type": "TYPE_BOOL" // the setting showLogoutButtonInTray is of type boolean
          }
        ]
      }
    ]
  },
  "fieldDescriptions": [ // human readable descriptions of the settings and their values
    {
      "field": "showLogoutButtonInTray",
      "knownValueDescriptions": [
        {
          "value": "true",
          "description": "Show logout button in tray." // description for showLogoutButtonInTray=true
        },
        {
          "value": "false",
          "description": "Do not show logout button in tray." // description for showLogoutButtonInTray=false
        }
      ]
    }
  ],
  "schemaName": "chrome.users.ShowLogoutButton" //  unique name to identify the policy
}

Имена схем политик

name схемы — это ее уникальный идентификатор следующего формата: {namespace}.{leafName} .

В приведенном выше примере полное имя схемы — chrome.users.ShowLogoutButton . Пространство имен — chrome.users. а имя листа — ShowLogoutButton .

Политики одинаковой области действия группируются в одном пространстве имен. Например, все схемы пользовательских политик имеют префикс chrome.users. пространство имен и все схемы политик принтеров имеют префикс chrome.printers. пространство имен.

Пространства имен

Пространство имен Ключ Требуется разрешение роли администратора
chrome.users. LEAF_NAME Сервисы > Управление Chrome > Настройки > Управление настройками пользователя.
chrome.users.apps. LEAF_NAME key="app_id" Сервисы > Управление Chrome > Настройки > Управление настройками пользователя > Управление настройками приложения.
chrome.users.appsconfig. LEAF_NAME Сервисы > Управление Chrome > Настройки > Управление настройками пользователя > Управление настройками приложения.
chrome.devices. LEAF_NAME Сервисы > Управление Chrome > Настройки > Управление настройками устройства ChromeOS.
chrome.devices.managedguest. LEAF_NAME Сервисы > Управление Chrome > Настройки > Управление настройками устройства ChromeOS.
chrome.devices.managedguest.apps. LEAF_NAME key="app_id" Сервисы > Управление Chrome > Настройки > Управление настройками устройства ChromeOS.
chrome.devices.kiosk. LEAF_NAME Сервисы > Управление Chrome > Настройки > Управление настройками устройства ChromeOS.
chrome.devices.kiosk.apps. LEAF_NAME key="app_id" Сервисы > Управление Chrome > Настройки > Управление настройками устройства ChromeOS.
chrome.devices.kiosk.appsconfig. LEAF_NAME key="app_id" Сервисы > Управление Chrome > Настройки > Управление настройками устройства ChromeOS.
chrome.printers. LEAF_NAME key="printer_id" Сервисы > Управление Chrome > Настройки > Управление принтерами.
chrome.printservers. LEAF_NAME key="print_server_id" Сервисы > Управление Chrome > Настройки > Управление принтерами.
chrome.networks.globalsettings. LEAF_NAME Службы > Настройки общего устройства
chrome.networks.wifi. LEAF_NAME key="network_id" Службы > Настройки общего устройства
chrome.networks.ethernet. LEAF_NAME key="network_id" Службы > Настройки общего устройства
chrome.networks.vpn. LEAF_NAME key="network_id" Службы > Настройки общего устройства
chrome.networks.certificates. LEAF_NAME key="network_id" Службы > Настройки общего устройства

Ключи схемы политики

Некоторые политики требуют дополнительного контекста для просмотра или изменения. Например:

  • Чтобы изменить политику для приложения, вам необходимо указать, какое приложение, заполнив key="app_id" .
  • Чтобы изменить политику настроек принтера в организационном подразделении, вам необходимо указать, какой принтер, заполнив key="printer_id" .

Эти схемы политик содержат additionalTargetKeyNames , в котором описаны ключи и значения, которые будут передаваться в ваших запросах API.

Дополнительные сведения см. в разделе Примеры кода .

Показать пример

{
  "name": "customers/C0202nabg/policySchemas/chrome.printers.AllowForUsers",
  "policyDescription": "Allows a printer for users in a given organization.",
  "additionalTargetKeyNames": [
    {
      "key": "printer_id",
      "keyDescription": "Id of printer as visible in Admin SDK printers API."
    }
  ],
  "definition": {
    "messageType": [
      {
        "name": "AllowForUsers",
        "field": [
          {
            "name": "allowForUsers",
            "number": 1,
            "label": "LABEL_OPTIONAL",
            "type": "TYPE_BOOL"
          }
        ]
      }
    ]
  },
  "fieldDescriptions": [
    {
      "field": "allowForUsers",
      "description": "Controls whether a printer is allowed for users in a given organization."
    }
  ],
  "schemaName": "chrome.printers.AllowForUsers"
}

Политики приложений

Некоторые из приведенных выше пространств имен предназначены для политики приложений , например политики пользовательских приложений, киоск-приложений, управляемых гостевых сеансов приложений и политик конфигурации киоск-приложений. Для политик приложений требуется app_id .

app_id формируется путем объединения типа приложения и идентификатора приложения. Например:

  • chrome:mkaakpdehdafacodkgkpghoibnmamcme представляет приложение Chrome «Google Drawings».
  • android:com.google.android.calendar представляет Android-приложение «Календарь Google».
  • web:https://canvas.apps.chrome представляет веб-приложение Canvas.

Поля с несколькими значениями

Поля с меткой LABEL_REPEATED представляют поля с несколькими значениями, например списки или массивы. Вы можете задать несколько значений этим полям. Дополнительные сведения см. в примерах кода .

Статус схемы политики

Каждая политика имеет объект policyApiLifecycle , отражающий ее текущий статус. Этот объект содержит следующие поля с подробной информацией о статусе политики:

  • Поле policyApiLifecycleStage показывает, какой из этапов в следующей таблице лучше всего описывает текущее состояние политики.
  • Поле description содержит более подробную информацию о текущем статусе этой политики.
  • Поле endSupport показывает окончательную дату поддержки политики, если она определена.
  • deprecatedInFavorOf можно установить только в том случае, если policyApiLifecycleStage имеет значение API_DEPRECATED. Он показывает полностью определенное пространство имен новых политик, в пользу которых текущая политика объявлена ​​устаревшей.
  • Поле scheduledToDeprecatePolicies соответствует устаревшему InFavorOf. Он показывает полностью определенное пространство имен старых политик, которые станут устаревшими из-за введения этой политики.

Этапы жизненного цикла

Этап Описание
API_UNSPECIFIED Текущий статус политики неизвестен. Зарезервировано, не используйте.
API_PREVIEW Политика пока не работает. Этот этап может перейти в API_CURRENT или API_DEVELOPMENT .
API_DEVELOPMENT Политика еще не доработана, и могут быть внесены критические изменения. Этот этап может перейти в API_CURRENT или API_DEPRECATED .
API_CURRENT Политика имеет официальный формат, но могут быть внесены некритичные изменения. Этот этап можно перенести на API_DEPRECATED .
API_DEPRECATED Эта политика устарела и может быть удалена в будущем. Администраторам следует прекратить использование этой политики.

Показать пример

{
  "name": "customers/C0202nabg/policySchemas/chrome.users.OutdatedPolicy",
  "policyDescription": "Just for demo, this is an outdated policy.",
  "definition": {
    "messageType": [
      {
        "name": "OutdatedPolicy",
        "field": [
          {
            "name": "outdatedField",
            "number": 1,
            "label": "LABEL_OPTIONAL",
            "type": "TYPE_BOOL"
          }
        ]
      }
    ]
  },
  "fieldDescriptions": [
    {
      "field": "outdatedField",
      "description": "This is an outdated field"
    }
  ],
  "schemaName": "chrome.users.OutdatedPolicy",
  "policyApiLifecycle": { // policy's current lifecycle status
    "policyApiLifecycleStage": "API_DEPRECATED",
    "description": "This policy is deprecated. Please stop using it",
    "endSupport": {
      "year": 2021,
      "month": 2,
      "day": 29
    }
    "deprecatedInFavorOf": "chrome.users.NewPolicy"
  }
}

{
  "name": "customers/C0202nabg/policySchemas/chrome.users.NewPolicy",
  "policyDescription": "Just for demo, this is a new policy.",
  "definition": {
    "messageType": [
      {
        "name": "NewPolicy",
        "field": [
          {
            "name": "newField",
            "number": 1,
            "label": "LABEL_OPTIONAL",
            "type": "TYPE_BOOL"
          }
        ]
      }
    ]
  },
  "fieldDescriptions": [
    {
      "field": "newField",
      "description": "This is an new field"
    }
  ],
  "schemaName": "chrome.users.NewPolicy",
  "policyApiLifecycle": { // policy's current lifecycle status
    "policyApiLifecycleStage": "API_CURRENT,
    "scheduledToDeprecatePolicies": "chrome.users.OutdatedPolicy"
  }
}

Уведомления о схеме политики

С некоторыми политиками связаны notices , в которых acknowledgement_required установлено значение true для определенных значений определенных полей политики. Для этих политик вам необходимо установить в специальном поле подтверждения значение true , прежде чем вы сможете установить это значение.

Дополнительные сведения см. в разделе Примеры кода .

Поддерживаемые платформы

supportedPlatforms — это список, который указывает, что политика будет применяться только к устройствам или пользователям на этих платформах. Все поддерживаемые платформы перечислены в следующей таблице.

Поддерживаемая платформа

Платформа Описание
PLATFORM_UNSPECIFIED Неуказанная платформа. Зарезервировано, не используйте.
CHROME_OS ChromeOS
CHROME_BROWSER Браузер Chrome для macOS/Windows/Linux
CHROME_BROWSER_FOR_ANDROID Браузер Chrome для Android
CHROME_BROWSER_FOR_IOS Браузер Chrome для iOS

Следующие шаги