REST Resource: customers.policySchemas

Risorsa: PolicySchema

Risorsa che rappresenta uno schema di criteri.

Rappresentazione JSON 
{
  "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)
  ]
}
Campi
name

string

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

string

Solo output. Descrizione dello schema dei criteri per il consumo da parte degli utenti.
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

Solo output. Nomi di chiavi aggiuntivi che verranno utilizzati per identificare la destinazione del valore del criterio. Quando specifichi un valore policyTargetKey, ogni chiave aggiuntiva specificata qui dovrà essere inclusa nella mappa additionalTargetKeys.
definition

object (FileDescriptorProto)

Definizione dello schema mediante descrittore di protocollo.
fieldDescriptions[]

object (PolicySchemaFieldDescription)

Solo output. Descrizione dettagliata di ciascun campo che fa parte dello schema. È consigliabile che i campi vengano visualizzati in base all'ordine all'interno dell'elenco, non in base al numero.
accessRestrictions[]

string

Solo output. Limitazioni di accesso specifiche relative a questo criterio.
notices[]

object (PolicySchemaNoticeDescription)

Solo output. Messaggi di avviso speciale relativi all'impostazione di determinati valori in determinati campi dello schema.
supportUri

string

Solo output. URI dell'articolo di assistenza correlato per questo schema.
schemaName

string

Solo output. Il nome completo dello schema dei criteri. Questo valore viene utilizzato per compilare il campo policySchema in PolicyValue durante la chiamata a BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies o BatchDeleteGroupPolicies.
validTargetResources[]

enum (TargetResource)

Solo output. Informazioni sulle risorse di destinazione applicabili per il criterio.
policyApiLifecycle

object (PolicyApiLifecycle)

Solo output. Informazioni attuali sul ciclo di vita.
categoryTitle

string

Titolo della categoria a cui appartiene un'impostazione.
supportedPlatforms[]

enum (Platform)

Solo output. L'elenco indica che il criterio verrà applicato solo ai dispositivi/utenti su queste piattaforme.

AdditionalTargetKeyName

Nomi di chiavi aggiuntivi che verranno utilizzati per identificare la destinazione del valore del criterio.

Rappresentazione JSON 
{
  "key": string,
  "keyDescription": string
}
Campi
key

string

Nome chiave.
keyDescription

string

Descrizione della chiave.

FileDescriptorProto

Descrive un file .proto completo.

Rappresentazione JSON 
{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string,
}
Campi
name

string

nome del file, in relazione alla radice dell'albero di origine
package

string

ad es. "foo", "foo.bar" e così via.
messageType[]

object (DescriptorProto)

Tutte le definizioni di primo livello in questo file.
enumType[]

object (EnumDescriptorProto)
syntax

string

La sintassi del file proto. I valori supportati sono "proto2", "proto3" ed "editions".

Se è presente edition, questo valore deve essere "versioni".

DescriptorProto

Descrive un tipo di messaggio.

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

string
field[]

object (FieldDescriptorProto)
nestedType[]

object (DescriptorProto)
enumType[]

object (EnumDescriptorProto)
oneofDecl[]

object (OneofDescriptorProto)

FieldDescriptorProto

Descrive un campo all'interno di un messaggio.

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

string
number

integer
label

enum (Label)
type

enum (Type)

Se typeName è impostato, non è necessario impostarlo. Se è impostato sia questo valore che typeName, il valore deve essere TYPE_ENUM, TYPE_MESSAGE o TYPE_GROUP.
typeName

string

Per i tipi di messaggio ed enum, questo è il nome del tipo. Se il nome inizia con un punto ".", è valido. In caso contrario, per trovare il tipo vengono utilizzate regole di ambito di tipo C++ (la ricerca viene eseguita prima nei tipi nidificati all'interno di questo messaggio, poi nell'elemento padre, fino allo spazio dei nomi principale).
defaultValue

string

Per i tipi numerici, contiene la rappresentazione testuale originale del valore. Per i valori booleani, "true" o "false". Per le stringhe, contiene i contenuti di testo predefiniti (senza caratteri di escape). Per i byte, contiene il valore con escape C. Tutti i byte >= 128 sono sottoposti a escape.
oneofIndex

integer

Se impostato, restituisce l'indice di un oneof nell'elenco oneofDecl del tipo contenitore. Questo campo fa parte di questo campo.
jsonName

string

Nome JSON di questo campo. Il valore è impostato dal compilatore di protocollo. Se l'utente ha impostato un valore "jsonName" in questo campo, verrà utilizzato il valore di tale opzione. In caso contrario, viene dedotto dal nome del campo convertendolo in camelCase.
proto3Optional

boolean

Se true, si tratta di un proto3 "facoltativo". Quando un campo proto3 è facoltativo, monitora la presenza indipendentemente dal tipo di campo.

Se proto3Optional è true, questo campo deve appartenere a un altro per segnalare ai vecchi client proto3 che la presenza viene monitorata per questo campo. Questa sintetica è nota come "sintetico" unodi e questo campo deve essere il suo unico membro (ogni campo facoltativo proto3 riceve il proprio uno di sintetico). Gli elementi sintetici esistono solo nel descrittore e non generano API. Gli elementi sintetici devono essere ordinati dopo che tutto è "reale" oneofs.

Per i campi del messaggio, proto3Optional non crea alcuna modifica semantica, poiché i campi del messaggio non ripetuti tengono sempre traccia della presenza. Tuttavia, indica ancora i dettagli semantici che indicano se l'utente ha scritto "facoltativo" o meno. Questo può essere utile per fare il round trip del file .proto. Per coerenza, forniamo anche ai campi dei messaggi uno sintetico, anche se non è obbligatorio monitorare la presenza. Questo è particolarmente importante perché il parser non è in grado di capire se un campo è un messaggio o un'enumerazione, quindi deve sempre crearne uno sintetico.

I campi facoltativi Proto2 non impostano questo flag perché sono già facoltativi con LABEL_OPTIONAL.

Etichetta

Enum
LABEL_OPTIONAL 0 è riservato agli errori
LABEL_REPEATED
LABEL_REQUIRED L'etichetta obbligatoria è consentita solo in proto2. In Proto3 e Edition è espressamente vietato. Nelle versioni, è possibile utilizzare la funzionalità fieldPresence per ottenere questo comportamento.

Tipo

Enum
TYPE_DOUBLE 0 è riservato agli errori. L'ordine è strano per motivi storici.
TYPE_FLOAT
TYPE_INT64 Non codificato ZigZag. I numeri negativi richiedono 10 byte. Utilizza TYPE_SINT64 se sono probabili valori negativi.
TYPE_UINT64
TYPE_INT32 Non codificato ZigZag. I numeri negativi richiedono 10 byte. Utilizza TYPE_SINT32 se sono probabili valori negativi.
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP Dati aggregati delimitato da tag. il tipo di gruppo è deprecato e non è supportato dopo proto2. Tuttavia, le implementazioni Proto3 devono comunque essere in grado di analizzare il formato del cavo di gruppo e trattare i campi del gruppo come campi sconosciuti. Nelle versioni, il formato del cavo di gruppo può essere attivato tramite la funzionalità messageEncoding.
TYPE_MESSAGE Dati aggregati delimitato da lunghezza.
TYPE_BYTES Novità della versione 2.
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 Utilizza la codifica ZigZag.
TYPE_SINT64 Utilizza la codifica ZigZag.

EnumDescriptorProto

Descrive un tipo di enum.

Rappresentazione JSON 
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
Campi
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

Descrive un valore all'interno di un'enumerazione.

Rappresentazione JSON 
{
  "name": string,
  "number": integer
}
Campi
name

string
number

integer

OneofDescriptorProto

Descrive uno di questi elementi.

Rappresentazione JSON 
{
  "name": string
}
Campi
name

string

PolicySchemaFieldDescription

Fornisce informazioni dettagliate per un determinato campo che fa parte di un PolicySchema.

Rappresentazione JSON 
{
  "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)
  }
}
Campi
field

string

Solo output. Il nome del campo per associato a questa descrizione.
description
(deprecated)

string

Deprecato. Utilizza invece name e fieldDescription. La descrizione del campo.
inputConstraint

string

Solo output. Eventuali vincoli di input associati ai valori per il campo.
knownValueDescriptions[]

object (PolicySchemaFieldKnownValueDescription)

Solo output. Se il campo ha un insieme di valori noti, questo campo fornisce una descrizione per questi valori.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

Solo output. Fornisce la descrizione dei campi nidificati in questo campo, se il campo è un tipo di messaggio che definisce più campi. È consigliabile che i campi vengano visualizzati in base all'ordine all'interno dell'elenco, non in base al numero.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Solo output. Fornisce un elenco di campi e valori. Almeno uno dei campi deve contenere il valore corrispondente per poter essere impostato.
requiredItems[]

object (PolicySchemaRequiredItems)

Solo output. Fornisce un elenco di campi che è obbligatorio impostare se questo campo ha un determinato valore.
defaultValue

value (Value format)

Solo output. Se il criterio non viene configurato, è il valore predefinito del client.
name

string

Solo output. Il nome del campo.
fieldDescription

string

Solo output. La descrizione del campo.
fieldConstraints

object (FieldConstraints)

Solo output. Informazioni su eventuali vincoli di input associati ai valori per il campo.

PolicySchemaFieldKnownValueDescription

Fornisce informazioni dettagliate su un valore noto consentito per un determinato campo in PolicySchema.

Rappresentazione JSON 
{
  "value": string,
  "description": string,
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ]
}
Campi
value

string

Solo output. La rappresentazione stringa del valore che è possibile impostare per il campo.
description

string

Solo output. Descrizione aggiuntiva per questo valore.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Solo output. Condizioni dei campi obbligatorie per la validità di questo valore.

PolicySchemaFieldDependencies

Il campo e il valore che deve avere affinché sia possibile impostare un altro campo.

Rappresentazione JSON 
{
  "sourceField": string,
  "sourceFieldValue": string
}
Campi
sourceField

string

Il campo di origine da cui dipende questo campo.
sourceFieldValue

string

Il valore che deve contenere il campo di origine per consentire l'impostazione di questo campo.

PolicySchemaRequiredItems

I campi che diventeranno obbligatori in base al valore di questo campo.

Rappresentazione JSON 
{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}
Campi
fieldConditions[]

string

I valori del campo che comportano l'applicazione forzata dei campi obbligatori. Un campo Conditions vuoto implica che qualsiasi valore assegnato a questo campo provocherà l'applicazione forzata dei campi obbligatori.
requiredFields[]

string

Campi obbligatori per effetto delle condizioni dei campi.

FieldConstraints

Informazioni su eventuali vincoli di intervallo.

Rappresentazione JSON 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
Campi
numericRangeConstraint

object (NumericRangeConstraint)

L'intervallo consentito per i campi numerici.
uploadedFileConstraints

object (UploadedFileConstraints)

Vincoli sul file caricato di un criterio del file. Se presente, questo criterio richiede un URL che possa essere recuperato caricando un file con i vincoli specificati in questo protocollo.

NumericRangeConstraint

Un vincolo ai limiti superiore e/o inferiore, con almeno uno impostato.

Rappresentazione JSON 
{
  "minimum": string,
  "maximum": string
}
Campi
minimum

string (int64 format)

Valore minimo.
maximum

string (int64 format)

Valore massimo.

UploadedFileConstraints

Vincoli sul file caricato di un criterio del file.

Rappresentazione JSON 
{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}
Campi
supportedContentTypes[]

enum (ContentType)

Tipi di file che possono essere caricati per un'impostazione.
sizeLimitBytes

string (int64 format)

Il limite per le dimensioni dei file caricati per un'impostazione, in byte.

ContentType

Tipi di file che possono essere caricati per un'impostazione.

Enum
CONTENT_TYPE_UNSPECIFIED Tipo di contenuto non specificato.
CONTENT_TYPE_PLAIN_TEXT Testo normale.
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.
CONTENT_TYPE_GZIP GZIP.
CONTENT_TYPE_CSV CSV.
CONTENT_TYPE_YAML YAML.
CONTENT_TYPE_IMAGE_WEBP per WebP

PolicySchemaNoticeDescription

Fornisce messaggi di avviso speciali relativi a un determinato valore in un campo che fa parte di un PolicySchema.

Rappresentazione JSON 
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
Campi
field

string

Solo output. Il nome del campo associato alla notifica.
noticeValue

string

Solo output. Il valore del campo che contiene una notifica. Quando il campo viene impostato su questo valore, all'utente potrebbe essere richiesto di confermare il messaggio di avviso affinché il valore venga impostato.
noticeMessage

string

Solo output. Il messaggio di avviso associato al valore del campo.
acknowledgementRequired

boolean

Solo output. Indica se l'utente deve confermare il messaggio di avviso prima di poter impostare il valore.

TargetResource

Tipi di risorse di destinazione

Enum
TARGET_RESOURCE_UNSPECIFIED Risorsa di destinazione non specificata.
ORG_UNIT Risorsa di destinazione dell'unità organizzativa.
GROUP risorsa di destinazione del gruppo.

PolicyApiLifecycle

Informazioni sul ciclo di vita.

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

string

Nel caso in cui questo criterio venga ritirato a favore di un altro criterio, lo spazio dei nomi completo o gli spazi dei nomi completi dei nuovi criteri verranno visualizzati in PolicyAPI. Può essere impostato solo se policyApiLifecycleStage è API_DEPRECATED.
scheduledToDeprecatePolicies[]

string

Corrispondenti all'InFavorOf deprecato, uno o più spazi dei nomi completi dei criteri precedenti che verranno ritirati a causa dell'introduzione di questo criterio.
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

Indica la fase attuale del ciclo di vita dell'API dei criteri.
description

string

Descrizione del ciclo di vita attuale.
endSupport

object (Date)

Data di fine del supporto per le norme attuali. Il tentativo di modificare un criterio dopo la data di fine del supporto comporterà una richiesta errata (errore 400). Può essere impostato solo se policyApiLifecycleStage è API_DEPRECATED.

PolicyApiLifecycleEnum

Fase del ciclo di vita dell'API dei criteri.

Enum
API_UNSPECIFIED Il ciclo di vita dell'API dei criteri non è specificato.
API_PREVIEW Le norme non funzionano ancora, ma avvisano gli sviluppatori sul formato. Questa fase può essere trasferita ad API_DEVELOPEMNT o API_CURRENT.
API_DEVELOPMENT Il formato del criterio può essere modificato in un modo incompatibile con le versioni precedenti (modifica effettiva). Questa fase può essere trasferita ad API_CURRENT o API_DEPRECATED. Può essere utilizzato per i criteri lanciati solo per i TT o lanciati per clienti selezionati per l'uso di emergenza.
API_CURRENT Norme in formato ufficiale. Il formato dei criteri può cambiare in modo compatibile con le versioni precedenti (modifica senza interruzioni). Esempio: questo criterio può introdurre un nuovo campo, che è considerato una modifica senza interruzioni, quando le maschere dei campi vengono utilizzate correttamente. Questa fase può essere trasferita ad API_DEPRECATED.
API_DEPRECATED Non usare più questo criterio. Questo criterio è deprecato e potrebbe/verrà rimosso in futuro. Molto probabilmente è stata introdotta una nuova norma per sostituire questa.

Data

Rappresenta una data di calendario intera o parziale, come un compleanno. L'ora del giorno e il fuso orario sono specificati altrove o non sono significativi. La data è relativa al calendario gregoriano. Può trattarsi di uno dei seguenti valori:

  • Una data completa, con valori diversi da zero per anno, mese e giorno.
  • Un mese e un giorno con zero anni (ad esempio, un anniversario).
  • Un anno a sé stante, con uno zero mese e uno zero-day.
  • Un anno e un mese, con zero day (ad esempio, la data di scadenza della carta di credito).

Tipi correlati:

Rappresentazione JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campi
year

integer

Anno della data. Il valore deve essere compreso tra 1 e 9999 oppure 0 per specificare una data senza anno.
month

integer

Mese dell'anno. Il valore deve essere compreso tra 1 e 12 oppure 0 per specificare un anno senza mese e giorno.
day

integer

Giorno di un mese. Deve essere compreso tra 1 e 31 e deve essere valido per l'anno e il mese oppure 0 per specificare un anno da solo o un anno e mese in cui il giorno non è significativo.

Piattaforma

Questa è un'enumerazione dei diversi gruppi di piattaforme su cui è supportato Chrome.

Enum
PLATFORM_UNSPECIFIED Piattaforma non specificata.
CHROME_OS ChromeOS
CHROME_BROWSER Browser Chrome per OSX/Windows/Linux.
CHROME_BROWSER_FOR_ANDROID Browser Chrome per Android.
CHROME_BROWSER_FOR_IOS Browser Chrome per iOS.

Metodi

get

 Ottieni uno schema di criteri specifico per un cliente in base al nome della risorsa.

list

 Restituisce un elenco di schemi di criteri che corrispondono a un valore di filtro specificato per un determinato cliente.