Richtlinienschemas

Chrome-Richtlinien werden durch die Schema Service API als Richtlinienschemas dargestellt. Jedes Richtlinienschema hat einen eindeutigen Namen zur Identifizierung, eine Definition von Einstellungsfeldern und deren Typen sowie eine menschenlesbare Beschreibung der Einstellungen auf Englisch.

Im Folgenden sehen Sie beispielsweise, wie die Schema Service API eine Einstellung darstellt, mit der eine Abmeldeschaltfläche in der Taskleiste von Chrome angezeigt werden kann. Eine vereinfachte Darstellung dieser Einstellung wäre bool showLogoutButtonInTray. Klicken Sie unten auf „Beispiel zeigen“, um zu sehen, wie die Schema Service API diese Einstellung darstellt.

Beispiel ansehen

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

Richtlinienschemanamen

Die name eines Schemas ist eine eindeutige Kennung im folgenden Format: {namespace}.{leafName}.

Im obigen Beispiel lautet der vollständige Schemaname chrome.users.ShowLogoutButton. Der Namespace ist chrome.users. und der Blattname ist ShowLogoutButton.

Richtlinien mit ähnlichem Bereich werden unter demselben Namespace gruppiert. Beispielsweise haben alle Nutzerrichtlinienschemas einen chrome.users.-Namespace und alle Druckerrichtlinienschemas mit einem chrome.printers.-Namespace versehen.

Namespaces

Namespace Schlüssel Erforderliche Administratorrollenberechtigung
chrome.users.LEAF_NAME   Dienste > Chrome Management > Einstellungen > Nutzereinstellungen verwalten
chrome.users.apps.LEAF_NAME key="app_id" Dienste > Chrome Management > Einstellungen > Nutzereinstellungen verwalten > Anwendungseinstellungen verwalten
chrome.users.appsconfig.LEAF_NAME   Dienste > Chrome Management > Einstellungen > Nutzereinstellungen verwalten > Anwendungseinstellungen verwalten
chrome.devices.LEAF_NAME   Dienste > Chrome Management > Einstellungen > ChromeOS-Geräteeinstellungen verwalten
chrome.devices.managedguest.LEAF_NAME   Dienste > Chrome Management > Einstellungen > ChromeOS-Geräteeinstellungen verwalten
chrome.devices.managedguest.apps.LEAF_NAME key="app_id" Dienste > Chrome Management > Einstellungen > ChromeOS-Geräteeinstellungen verwalten
chrome.devices.kiosk.LEAF_NAME   Dienste > Chrome Management > Einstellungen > ChromeOS-Geräteeinstellungen verwalten
chrome.devices.kiosk.apps.LEAF_NAME key="app_id" Dienste > Chrome Management > Einstellungen > ChromeOS-Geräteeinstellungen verwalten
chrome.devices.kiosk.appsconfig.LEAF_NAME   Dienste > Chrome Management > Einstellungen > ChromeOS-Geräteeinstellungen verwalten
chrome.printers.LEAF_NAME key="printer_id" Dienste > Chrome Management > Einstellungen > Drucker verwalten
chrome.printservers.LEAF_NAME key="print_server_id" Dienste > Chrome Management > Einstellungen > Drucker verwalten
chrome.networks.globalsettings.LEAF_NAME   Dienste > Einstellungen für gemeinsam verwendete Geräte
chrome.networks.wifi.LEAF_NAME key="network_id" Dienste > Einstellungen für gemeinsam verwendete Geräte
chrome.networks.ethernet.LEAF_NAME key="network_id" Dienste > Einstellungen für gemeinsam verwendete Geräte
chrome.networks.vpn.LEAF_NAME key="network_id" Dienste > Einstellungen für gemeinsam verwendete Geräte
chrome.networks.certificates.LEAF_NAME key="network_id" Dienste > Einstellungen für gemeinsam verwendete Geräte

Richtlinienschemaschlüssel

Bei einigen Richtlinien ist zusätzlicher Kontext erforderlich, um angesehen oder geändert werden zu können. Beispiel:

  • Wenn Sie die Richtlinie für eine Anwendung ändern möchten, müssen Sie die Anwendung durch Ausfüllen von key="app_id" angeben.
  • Wenn Sie die Richtlinien für Druckereinstellungen in einer Organisationseinheit ändern möchten, müssen Sie den entsprechenden Drucker durch Ausfüllen von key="printer_id" angeben.

Diese Richtlinienschemas enthalten den Abschnitt additionalTargetKeyNames, in dem die Schlüssel und Werte beschrieben werden, die in Ihren API-Anfragen übergeben werden sollen.

Weitere Informationen finden Sie unter Codebeispiele.

Beispiel ansehen

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

Einige der oben genannten Namespaces sind für App-Richtlinien bestimmt, z. B. Nutzer-Apps, Kiosk-Apps, Apps für verwaltete Gastsitzungen und Kiosk-Apps-Konfigurationsrichtlinien. Anwendungsrichtlinien erfordern ein app_id.

Ein app_id wird durch Kombination des App-Typs und der App-ID gebildet. Beispiel:

  • chrome:mkaakpdehdafacodkgkpghoibnmamcme steht für die Chrome-App "Google Zeichnungen"
  • android:com.google.android.calendar steht für die Android-App „Google Kalender“
  • web:https://canvas.apps.chrome steht für die Canvas-Web-App

Felder mit mehreren Werten

Felder mit dem Label LABEL_REPEATED stellen Felder mit mehreren Werten wie Listen oder Arrays dar. Sie können diesen Feldern verschiedene Werte zuweisen. Weitere Informationen finden Sie in den Codebeispielen.

Status des Richtlinienschemas

Jede Richtlinie hat ein policyApiLifecycle-Objekt, das ihren aktuellen Status darstellt. Dieses Objekt enthält die folgenden Felder mit Details zum Status der Richtlinie:

  • Das Feld policyApiLifecycleStage gibt an, welche der Phasen in der folgenden Tabelle den aktuellen Status der Richtlinie am besten beschreibt.
  • Das Feld „description“ enthält weitere Details zum aktuellen Status dieser Richtlinie.
  • Im Feld endSupport wird das endgültige Unterstützungsdatum für die Richtlinie angezeigt, sofern eines definiert wurde.
  • Die deprecatedInFavorOf kann nur festgelegt werden, wenn policyApiLifecycleStage API_DEPRECATED ist. Sie zeigt die voll qualifizierten Namespaces der neuen Richtlinien, für die die aktuelle Richtlinie veraltet ist.
  • Das Feld scheduledToDeprecatePolicies entspricht VerworfenenInFavorOf. Sie zeigt die voll qualifizierten Namespaces der alten Richtlinien, die aufgrund der Einführung dieser Richtlinie eingestellt werden.

Lebenszyklusphasen

Phase Beschreibung
API_UNSPECIFIED Der aktuelle Status der Richtlinie ist unbekannt. Reserviert, nicht verwenden.
API_PREVIEW Die Richtlinie funktioniert noch nicht. Diese Phase kann an API_CURRENT oder API_DEVELOPMENT übertragen werden.
API_DEVELOPMENT Die Richtlinie ist noch nicht endgültig und funktionsgefährdende Änderungen werden möglicherweise eingeführt. Diese Phase kann an API_CURRENT oder API_DEPRECATED übertragen werden.
API_CURRENT Die Richtlinie hat ein offizielles Format. Es können jedoch abwärtskompatible Änderungen eingeführt werden. Diese Phase kann an API_DEPRECATED übertragen werden.
API_DEPRECATED Diese Richtlinie ist veraltet und wird möglicherweise in Zukunft entfernt. Administratoren sollten diese Richtlinie nicht mehr verwenden.

Beispiel ansehen

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

Hinweise zum Richtlinienschema

Mit einigen Richtlinien ist notices verknüpft, wobei acknowledgement_required für bestimmte Werte bestimmter Richtlinienfelder auf true gesetzt ist. Für diese Richtlinien müssen Sie ein spezielles Bestätigungsfeld auf true setzen, bevor Sie den Wert festlegen können.

Weitere Informationen finden Sie unter Codebeispiele.

Unterstützte Plattformen

supportedPlatforms ist eine Liste, die angibt, dass die Richtlinie nur für Geräte oder Nutzer auf diesen Plattformen gilt. In der folgenden Tabelle sind alle unterstützten Plattformen aufgeführt.

Unterstützte Plattform

Plattform Beschreibung
PLATFORM_UNSPECIFIED Keine Plattform angegeben. Reserviert, nicht verwenden.
CHROME_OS ChromeOS
CHROME_BROWSER Chrome-Browser für macOS/Windows/Linux
CHROME_BROWSER_FOR_ANDROID Chrome-Browser für Android
CHROME_BROWSER_FOR_IOS Chrome-Browser für iOS

Nächste Schritte