REST Resource: customers.policySchemas

Ressource: PolicySchema

Ressource, die ein Richtlinienschema darstellt.

JSON-Darstellung 
{
  "name": string,
  "policyDescription": string,
  "additionalTargetKeyNames": [
    {
      object (AdditionalTargetKeyName)
    }
  ],
  "definition": {
    object (FileDescriptorProto)
  },
  "fieldDescriptions": [
    {
      object (PolicySchemaFieldDescription)
    }
  ],
  "accessRestrictions": [
    string
  ],
  "notices": [
    {
      object (PolicySchemaNoticeDescription)
    }
  ],
  "supportUri": string,
  "schemaName": string,
  "validTargetResources": [
    enum (TargetResource)
  ],
  "policyApiLifecycle": {
    object (PolicyApiLifecycle)
  },
  "categoryTitle": string,
  "supportedPlatforms": [
    enum (Platform)
  ]
}
Felder
name

string

Format: name=customers/{customer}/policySchemas/{schema_namespace}
policyDescription

string

Nur Ausgabe. Beschreibung des Richtlinienschemas für die Nutzernutzung.
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

Nur Ausgabe. Zusätzliche Schlüsselnamen, die zum Identifizieren des Ziels des Richtlinienwerts verwendet werden. Beim Angeben einer policyTargetKey muss jeder der hier angegebenen zusätzlichen Schlüssel in die additionalTargetKeys-Zuordnung aufgenommen werden.
definition

object (FileDescriptorProto)

Schemadefinition mit Proto-Deskriptor.
fieldDescriptions[]

object (PolicySchemaFieldDescription)

Nur Ausgabe. Detaillierte Beschreibung jedes Felds, das Teil des Schemas ist. Felder sollten nach der Sortierung in dieser Liste und nicht nach Feldnummer angezeigt werden.
accessRestrictions[]

string

Nur Ausgabe. Spezifische Zugriffsbeschränkungen im Zusammenhang mit dieser Richtlinie.
notices[]

object (PolicySchemaNoticeDescription)

Nur Ausgabe. Besondere Hinweise zum Festlegen bestimmter Werte in bestimmten Feldern des Schemas.
supportUri

string

Nur Ausgabe. URI zum verwandten Hilfeartikel für dieses Schema.
schemaName

string

Nur Ausgabe. Der voll qualifizierte Name des Richtlinienschemas. Mit diesem Wert wird das Feld policySchema in PolicyValue ausgefüllt, wenn BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies oder BatchDeleteGroupPolicies aufgerufen wird.
validTargetResources[]

enum (TargetResource)

Nur Ausgabe. Informationen zu anwendbaren Zielressourcen für die Richtlinie.
policyApiLifecycle

object (PolicyApiLifecycle)

Nur Ausgabe. Aktuelle Lebenszyklusinformationen.
categoryTitle

string

Titel der Kategorie, zu der eine Einstellung gehört.
supportedPlatforms[]

enum (Platform)

Nur Ausgabe. Laut Liste gilt die Richtlinie nur für Geräte/Nutzer auf diesen Plattformen.

AdditionalTargetKeyName

Zusätzliche Schlüsselnamen, die zum Identifizieren des Ziels des Richtlinienwerts verwendet werden.

JSON-Darstellung 
{
  "key": string,
  "keyDescription": string
}
Felder
key

string

Schlüsselname.
keyDescription

string

Beschreibung des Schlüssels.

FileDescriptorProto

Beschreibt eine vollständige .proto-Datei.

JSON-Darstellung 
{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string,
}
Felder
name

string

Dateiname, relativ zum Stamm der Quellstruktur
package

string

z.B. „foo“, „foo.bar“ usw.
messageType[]

object (DescriptorProto)

Alle übergeordneten Definitionen in dieser Datei.
enumType[]

object (EnumDescriptorProto)
syntax

string

Die Syntax der .proto-Datei. Die unterstützten Werte sind „proto2“, „proto3“ und „editions“.

Wenn edition vorhanden ist, muss dieser Wert „editions“ sein.

DescriptorProto

Beschreibt einen Nachrichtentyp.

JSON-Darstellung 
{
  "name": string,
  "field": [
    {
      object (FieldDescriptorProto)
    }
  ],
  "nestedType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "oneofDecl": [
    {
      object (OneofDescriptorProto)
    }
  ]
}
Felder
name

string
field[]

object (FieldDescriptorProto)
nestedType[]

object (DescriptorProto)
enumType[]

object (EnumDescriptorProto)
oneofDecl[]

object (OneofDescriptorProto)

FieldDescriptorProto

Beschreibt ein Feld in einer Nachricht.

JSON-Darstellung 
{
  "name": string,
  "number": integer,
  "label": enum (Label),
  "type": enum (Type),
  "typeName": string,
  "defaultValue": string,
  "oneofIndex": integer,
  "jsonName": string,
  "proto3Optional": boolean
}
Felder
name

string
number

integer
label

enum (Label)
type

enum (Type)

Wenn „typeName“ festgelegt ist, muss diese nicht festgelegt werden. Wenn sowohl dieser Wert als auch typeName festgelegt ist, muss entweder TYPE_ENUM, TYPE_MESSAGE oder TYPE_GROUP angegeben werden.
typeName

string

Bei Nachrichten- und Enum-Typen ist dies der Name des Typs. Beginnt der Name mit einem „.“, ist er voll qualifiziert. Andernfalls werden C++-ähnliche Bereichsregeln verwendet, um den Typ zu finden (d.h. zuerst werden die verschachtelten Typen innerhalb dieser Nachricht, dann innerhalb des übergeordneten Elements bis zum Stamm-Namespace durchsucht).
defaultValue

string

Enthält bei numerischen Typen die ursprüngliche Textdarstellung des Werts. Für boolesche Werte: „true“ oder „false“. Enthält bei Zeichenfolgen den Standardtextinhalt (keine Escapesequenz). Enthält für Bytes den maskierten C-Wert. Alle Bytes >= 128 werden maskiert.
oneofIndex

integer

Wenn festgelegt, wird der Index eines oneof in der oneofDecl-Liste des enthaltenden Typs angegeben. Dieses Feld gehört zu diesem oneof.
jsonName

string

JSON-Name dieses Felds. Der Wert wird vom Protokoll-Compiler festgelegt. Wenn der Nutzer einen „jsonName“ festgelegt hat für dieses Feld auswählen, wird der Wert dieser Option verwendet. Andernfalls wird er aus dem Feldnamen abgeleitet, indem er in „camelCase“ konvertiert wird.
proto3Optional

boolean

Bei „true“ ist dies ein „optionales“ proto3-Element. Wenn ein proto3-Feld optional ist, wird die Präsenz unabhängig vom Feldtyp erfasst.

Wenn proto3Optional "true" ist, muss dieses Feld zu einem oneof gehören, um alten proto3-Clients zu signalisieren, dass dieses Feld vorhanden ist. Dieses oneof wird als „synthetische“ oneof. Dieses Feld muss sein einziges Mitglied sein (jedes optionale proto3-Feld erhält ein eigenes synthetisches oneof). Synthetische oneofs sind nur im Deskriptor vorhanden und generieren keine API. Synthetische oneofs müssen nach allen „echten“ oneofs.

Bei Nachrichtenfeldern erstellt proto3Optional keine semantische Änderung, da nicht wiederkehrende Nachrichtenfelder immer die Präsenz erfassen. Sie gibt jedoch weiterhin die semantischen Details an, ob der Nutzer „optional“ eingegeben hat. oder nicht. Dies kann beim Roundtrip der .proto-Datei nützlich sein. Aus Konsistenzgründen geben wir für Nachrichtenfelder ebenfalls ein synthetisches oneof, auch wenn dies nicht erforderlich ist, um die Präsenz zu verfolgen. Dies ist besonders wichtig, da der Parser nicht erkennen kann, ob ein Feld eine Nachricht oder eine Enum ist. Daher muss er immer ein synthetisches oneof erstellen.

Bei optionalen Proto2-Feldern wird dieses Flag nicht festgelegt, da sie bereits mit LABEL_OPTIONAL als optional gekennzeichnet sind.

Label

Enums
LABEL_OPTIONAL 0 ist für Fehler reserviert
LABEL_REPEATED
LABEL_REQUIRED Das erforderliche Label ist nur in proto2 zulässig. In proto3 und Versionen ist dies ausdrücklich verboten. In Versionen kann die Funktion fieldPresence verwendet werden, um dieses Verhalten zu erhalten.

Typ

Enums
TYPE_DOUBLE 0 ist für Fehler reserviert. Die Reihenfolge ist aus historischen Gründen seltsam.
TYPE_FLOAT
TYPE_INT64 Nicht ZigZag-codiert. Negative Zahlen benötigen 10 Byte. Verwenden Sie TYPE_SINT64, wenn negative Werte wahrscheinlich sind.
TYPE_UINT64
TYPE_INT32 Nicht ZigZag-codiert. Negative Zahlen benötigen 10 Byte. Verwenden Sie TYPE_SINT32, wenn negative Werte wahrscheinlich sind.
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP Durch Tags getrennte Aggregatfunktion. Der Gruppentyp wurde verworfen und wird nach proto2 nicht mehr unterstützt. Proto3-Implementierungen sollten jedoch weiterhin in der Lage sein, das Gruppenübertragungsformat zu parsen und Gruppenfelder als unbekannte Felder zu behandeln. In Editions kann das Gruppenübertragungsformat über die Funktion messageEncoding aktiviert werden.
TYPE_MESSAGE Durch die Länge getrennte Aggregation.
TYPE_BYTES Neu in Version 2.
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 Verwendet ZigZag-Codierung.
TYPE_SINT64 Verwendet ZigZag-Codierung.

EnumDescriptorProto

Beschreibt einen Enum-Typ.

JSON-Darstellung 
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
Felder
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

Beschreibt einen Wert innerhalb einer Enum.

JSON-Darstellung 
{
  "name": string,
  "number": integer
}
Felder
name

string
number

integer

OneofDescriptorProto

Beschreibt ein oneof.

JSON-Darstellung 
{
  "name": string
}
Felder
name

string

PolicySchemaFieldDescription

Enthält detaillierte Informationen zu einem bestimmten Feld, das Teil eines PolicySchemas ist.

JSON-Darstellung 
{
  "field": string,
  "description": string,
  "inputConstraint": string,
  "knownValueDescriptions": [
    {
      object (PolicySchemaFieldKnownValueDescription)
    }
  ],
  "nestedFieldDescriptions": [
    {
      object (PolicySchemaFieldDescription)
    }
  ],
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ],
  "requiredItems": [
    {
      object (PolicySchemaRequiredItems)
    }
  ],
  "defaultValue": value,
  "name": string,
  "fieldDescription": string,
  "fieldConstraints": {
    object (FieldConstraints)
  }
}
Felder
field

string

Nur Ausgabe. Der Name des Feldes, das mit dieser Beschreibung verknüpft ist.
description
(deprecated)

string

Verworfen. Verwenden Sie stattdessen „name“ und „fieldDescription“. Die Beschreibung des Felds.
inputConstraint

string

Nur Ausgabe. Alle Eingabeeinschränkungen, die den Werten für das Feld zugeordnet sind.
knownValueDescriptions[]

object (PolicySchemaFieldKnownValueDescription)

Nur Ausgabe. Wenn das Feld eine Reihe bekannter Werte enthält, enthält dieses Feld eine Beschreibung dieser Werte.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

Nur Ausgabe. Liefert die Beschreibung der in diesem Feld verschachtelten Felder, wenn es sich um einen Nachrichtentyp handelt, mit dem mehrere Felder definiert sind. Felder sollten nach der Sortierung in dieser Liste und nicht nach Feldnummer angezeigt werden.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Nur Ausgabe. Stellt eine Liste von Feldern und Werten bereit. Mindestens eines der Felder muss den entsprechenden Wert enthalten, damit dieses Feld festgelegt werden kann.
requiredItems[]

object (PolicySchemaRequiredItems)

Nur Ausgabe. Enthält eine Liste der Felder, die festgelegt werden müssen, wenn dieses Feld einen bestimmten Wert hat.
defaultValue

value (Value format)

Nur Ausgabe. Standardeinstellung des Clients, wenn die Richtlinie nicht konfiguriert ist.
name

string

Nur Ausgabe. Der Name des Felds.
fieldDescription

string

Nur Ausgabe. Die Beschreibung des Felds.
fieldConstraints

object (FieldConstraints)

Nur Ausgabe. Informationen zu Eingabeeinschränkungen, die für die Werte für das Feld gelten.

PolicySchemaFieldKnownValueDescription

Liefert detaillierte Informationen zu einem bekannten Wert, der für ein bestimmtes Feld in einem PolicySchema zulässig ist.

JSON-Darstellung 
{
  "value": string,
  "description": string,
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ]
}
Felder
value

string

Nur Ausgabe. Die String-Darstellung des Werts, der für das Feld festgelegt werden kann.
description

string

Nur Ausgabe. Zusätzliche Beschreibung für diesen Wert.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Nur Ausgabe. Feldbedingungen, die erforderlich sind, damit dieser Wert gültig ist.

PolicySchemaFieldDependencies

Das Feld und der Wert, den es haben muss, damit ein anderes Feld festgelegt werden kann.

JSON-Darstellung 
{
  "sourceField": string,
  "sourceFieldValue": string
}
Felder
sourceField

string

Das Quellenfeld, von dem dieses Feld abhängt.
sourceFieldValue

string

Der Wert, den das Quellfeld haben muss, damit dieses Feld festgelegt werden kann.

PolicySchemaRequiredItems

Die Felder, die basierend auf dem Wert dieses Felds erforderlich werden.

JSON-Darstellung 
{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}
Felder
fieldConditions[]

string

Die Werte des Felds, die die Erzwingung von Pflichtfeldern auslösen. Ein leeres FeldConditions impliziert, dass jeder diesem Feld zugewiesene Wert die Erzwingung eines Pflichtfelds auslöst.
requiredFields[]

string

Die Felder, die aufgrund der Feldbedingungen erforderlich sind.

FieldConstraints

Informationen zu Bereichseinschränkungen.

JSON-Darstellung 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
Felder
numericRangeConstraint

object (NumericRangeConstraint)

Der zulässige Bereich für numerische Felder.
uploadedFileConstraints

object (UploadedFileConstraints)

Einschränkungen für die hochgeladene Datei einer Dateirichtlinie. Falls vorhanden, verlangt diese Richtlinie eine URL, die durch Hochladen einer Datei mit den in diesem Proto angegebenen Einschränkungen abgerufen werden kann.

NumericRangeConstraint

Eine Einschränkung der Ober- und/oder Untergrenzen, wobei mindestens eine festgelegt ist.

JSON-Darstellung 
{
  "minimum": string,
  "maximum": string
}
Felder
minimum

string (int64 format)

Minimalwert.
maximum

string (int64 format)

Höchstwert.

UploadedFileConstraints

Einschränkungen für die hochgeladene Datei einer Dateirichtlinie.

JSON-Darstellung 
{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}
Felder
supportedContentTypes[]

enum (ContentType)

Dateitypen, die für eine Einstellung hochgeladen werden können.
sizeLimitBytes

string (int64 format)

Die Größenbeschränkung für hochgeladene Dateien für eine Einstellung in Byte.

ContentType

Dateitypen, die für eine Einstellung hochgeladen werden können.

Enums
CONTENT_TYPE_UNSPECIFIED Nicht angegebener Inhaltstyp.
CONTENT_TYPE_PLAIN_TEXT Nur Text
CONTENT_TYPE_HTML HTML:
CONTENT_TYPE_IMAGE_JPEG JPEG
CONTENT_TYPE_IMAGE_GIF GIF.
CONTENT_TYPE_IMAGE_PNG PNG
CONTENT_TYPE_JSON JSON
CONTENT_TYPE_ZIP ZIP-Datei.
CONTENT_TYPE_GZIP GZIP.
CONTENT_TYPE_CSV CSV-Datei.
CONTENT_TYPE_YAML YAML.
CONTENT_TYPE_IMAGE_WEBP WebP.

PolicySchemaNoticeDescription

Stellt spezielle Hinweise bereit, die sich auf einen bestimmten Wert in einem Feld beziehen, das Teil eines PolicySchemas ist.

JSON-Darstellung 
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
Felder
field

string

Nur Ausgabe. Der Feldname, der mit der Benachrichtigung verknüpft ist.
noticeValue

string

Nur Ausgabe. Der Wert des Felds mit einem Hinweis. Wenn das Feld auf diesen Wert gesetzt wird, muss der Nutzer möglicherweise die Benachrichtigung bestätigen, damit der Wert festgelegt werden kann.
noticeMessage

string

Nur Ausgabe. Die Benachrichtigungsnachricht, die mit dem Wert des Felds verknüpft ist.
acknowledgementRequired

boolean

Nur Ausgabe. Gibt an, ob der Nutzer die Benachrichtigungsnachricht bestätigen muss, bevor der Wert festgelegt werden kann.

TargetResource

Zielressourcentypen

Enums
TARGET_RESOURCE_UNSPECIFIED Nicht angegebene Zielressource.
ORG_UNIT Zielressource der Organisationseinheit.
GROUP Gruppenzielressource.

PolicyApiLifecycle

Informationen zum Lebenszyklus.

JSON-Darstellung 
{
  "deprecatedInFavorOf": [
    string
  ],
  "scheduledToDeprecatePolicies": [
    string
  ],
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  }
}
Felder
deprecatedInFavorOf[]

string

Für den Fall, dass diese Richtlinie zugunsten einer anderen Richtlinie eingestellt wurde, die vollständig qualifizierten Namespaces der neuen Richtlinien, wie sie in PolicyAPI angezeigt werden. Kann nur festgelegt werden, wenn policyApiLifecycleStage den Wert API_DEPRECATED hat.
scheduledToDeprecatePolicies[]

string

Die vollständig qualifizierten Namespaces der alten Richtlinien, die aufgrund der Einführung dieser Richtlinie eingestellt werden, entsprechen dem Thema „InFavorOf“, das eingestellt wurde.
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

Gibt die aktuelle Lebenszyklusphase der Richtlinien-API an.
description

string

Beschreibung des aktuellen Lebenszyklus.
endSupport

object (Date)

Enddatum der Unterstützung für die aktuelle Richtlinie. Der Versuch, eine Richtlinie nach ihrem Enddatum zu ändern, führt zu einer ungültigen Anfrage (Fehler 400). Kann nur festgelegt werden, wenn policyApiLifecycleStage den Wert API_DEPRECATED hat.

PolicyApiLifecycleEnum

Lebenszyklusphase der Richtlinien-API.

Enums
API_UNSPECIFIED Der Lebenszyklus der Richtlinien-API ist nicht angegeben.
API_PREVIEW Die Richtlinie funktioniert noch nicht, Entwickler werden aber über das Format informiert. Diese Phase kann zu API_DEVELOPEMNT oder API_CURRENT übertragen werden.
API_DEVELOPMENT Die Richtlinie kann das Format auf abwärtsinkompatible Weise ändern (nicht abwärtskompatible Änderung). Diese Phase kann zu API_CURRENT oder API_DEPRECATED übertragen werden. Dies kann für Richtlinien verwendet werden, die nur für Sprachausgabe-Benachrichtigungen oder nur für ausgewählte Kunden zur Verwendung im Notfall eingeführt werden.
API_CURRENT Richtlinie im offiziellen Format. Die Richtlinie kann das Format auf abwärtskompatible Weise ändern (abwärtskompatible Änderung). Beispiel: Mit dieser Richtlinie kann ein neues Feld eingeführt werden, das bei ordnungsgemäßer Verwendung von Feldmasken als abwärtskompatible Änderung gilt. Diese Phase kann zu API_DEPRECATED übertragen werden.
API_DEPRECATED Bitte verwenden Sie diese Richtlinie nicht mehr. Diese Richtlinie ist veraltet und wird in Zukunft möglicherweise entfernt. Höchstwahrscheinlich wurde diese durch eine neue Richtlinie ersetzt.

Datum

Stellt ein ganzes Kalenderdatum oder einen Teil davon dar, z. B. einen Geburtstag. Tageszeit und Zeitzone werden entweder an anderer Stelle angegeben oder sind unbedeutend. Das Datum bezieht sich auf den gregorianischen Kalender. Dies kann Folgendes darstellen:

  • Ein vollständiges Datum mit Werten für Jahr, Monat und Tag ungleich null.
  • Ein Monat und ein Tag mit einem Jahr von 0 (z. B. ein Jahrestag).
  • Ein Jahr für sich alleine, mit einem Monat und einem Tag von null.
  • Ein Jahr und ein Monat mit 0 Tag (z. B. dem Ablaufdatum einer Kreditkarte).

Ähnliche Typen:

JSON-Darstellung 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Felder
year

integer

Jahr des Datums. Muss zwischen 1 und 9999 liegen oder 0, um ein Datum ohne Jahr anzugeben.
month

integer

Monat eines Jahres. Muss zwischen 1 und 12 liegen oder 0, um ein Jahr ohne Monat und Tag anzugeben.
day

integer

Tag im Monat. Muss zwischen 1 und 31 liegen und für das Jahr und den Monat gültig sein, oder 0, um ein Jahr allein oder ein Jahr und Monat anzugeben, wenn der Tag nicht von Bedeutung ist.

Plattform

Dies ist eine Aufzählung der verschiedenen Plattformgruppen, auf denen Chrome unterstützt wird.

Enums
PLATFORM_UNSPECIFIED Keine Plattform angegeben.
CHROME_OS ChromeOS
CHROME_BROWSER Chrome-Browser für OSX/Windows/Linux.
CHROME_BROWSER_FOR_ANDROID Chrome-Browser für Android
CHROME_BROWSER_FOR_IOS Chrome-Browser für iOS

Methoden

get

 Rufen Sie ein bestimmtes Richtlinienschema für einen Kunden anhand seines Ressourcennamens ab.

list

 Ruft eine Liste von Richtlinienschemas ab, die einem angegebenen Filterwert für einen bestimmten Kunden entsprechen.