REST Resource: customers.policySchemas

Recurso: PolicySchema

Recurso que representa un esquema de política.

Representación 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)
  ]
}
Campos
name

string

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

string

Solo salida. Descripción del esquema de política para el consumo de los usuarios.
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

Solo salida. Nombres de claves adicionales que se usarán para identificar el destino del valor de la política. Cuando se especifica un policyTargetKey, cada una de las claves adicionales especificadas aquí deberá incluirse en el mapa additionalTargetKeys.
definition

object (FileDescriptorProto)

Definición de esquema con el descriptor proto.
fieldDescriptions[]

object (PolicySchemaFieldDescription)

Solo salida. Descripción detallada de cada campo que forma parte del esquema. Se sugiere que los campos se muestren según el orden en esta lista y no por el número de campo.
accessRestrictions[]

string

Solo salida. Restricciones de acceso específicas relacionadas con esta política.
notices[]

object (PolicySchemaNoticeDescription)

Solo salida. Mensajes de aviso especial relacionados con la configuración de ciertos valores en ciertos campos del esquema.
supportUri

string

Solo salida. Es el URI del artículo de asistencia relacionado para este esquema.
schemaName

string

Solo salida. El nombre completamente calificado del esquema de política. Este valor se usa para completar el campo policySchema en PolicyValue cuando se llama a BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies o BatchDeleteGroupPolicies.
validTargetResources[]

enum (TargetResource)

Solo salida. Información sobre los recursos de destino aplicables a la política.
policyApiLifecycle

object (PolicyApiLifecycle)

Solo salida. Información actual del ciclo de vida.
categoryTitle

string

Título de la categoría a la que pertenece un parámetro de configuración.
supportedPlatforms[]

enum (Platform)

Solo salida. La lista indica que la política solo se aplicará a los dispositivos o usuarios en estas plataformas.

AdditionalTargetKeyName

Nombres de claves adicionales que se usarán para identificar el destino del valor de la política.

Representación JSON 
{
  "key": string,
  "keyDescription": string
}
Campos
key

string

Nombre de la clave.
keyDescription

string

Descripción de la clave.

FileDescriptorProto

Describe un archivo .proto completo.

Representación JSON 
{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string,
}
Campos
name

string

nombre del archivo, en relación con la raíz del árbol de fuentes
package

string

p.ej., "foo", "foo.bar", etc.
messageType[]

object (DescriptorProto)

Todas las definiciones de nivel superior de este archivo.
enumType[]

object (EnumDescriptorProto)
syntax

string

La sintaxis del archivo proto. Los valores admitidos son "proto2", "proto3" y "editions".

Si hay edition, este valor debe ser "editions".

DescriptorProto

Describe un tipo de mensaje.

Representación JSON 
{
  "name": string,
  "field": [
    {
      object (FieldDescriptorProto)
    }
  ],
  "nestedType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "oneofDecl": [
    {
      object (OneofDescriptorProto)
    }
  ]
}
Campos
name

string
field[]

object (FieldDescriptorProto)
nestedType[]

object (DescriptorProto)
enumType[]

object (EnumDescriptorProto)
oneofDecl[]

object (OneofDescriptorProto)

FieldDescriptorProto

Describe un campo dentro de un mensaje.

Representación JSON 
{
  "name": string,
  "number": integer,
  "label": enum (Label),
  "type": enum (Type),
  "typeName": string,
  "defaultValue": string,
  "oneofIndex": integer,
  "jsonName": string,
  "proto3Optional": boolean
}
Campos
name

string
number

integer
label

enum (Label)
type

enum (Type)

Si se establece typeName, no es necesario establecerlo. Si se configuran este valor y typeName, este debe ser TYPE_ENUM, TYPE_MESSAGE o TYPE_GROUP.
typeName

string

Para los tipos de mensaje y enumeración, este es el nombre del tipo. Si el nombre comienza con “.”, significa que está completamente calificado. De lo contrario, se usan reglas de alcance similares a C++ para encontrar el tipo (es decir, primero se buscan los tipos anidados dentro de este mensaje y, luego, en el elemento superior, hasta el espacio de nombres raíz).
defaultValue

string

Para los tipos numéricos, contiene la representación de texto original del valor. Para valores booleanos, “verdadero” o “false”. Para cadenas, contiene el contenido de texto predeterminado (sin escape de ninguna manera). Para bytes, contiene el valor de escape C. Todos los bytes >= 128 tienen caracteres de escape.
oneofIndex

integer

Si se establece, muestra el índice de un oneof en la lista oneofDecl del tipo contenedor. Este campo forma parte de ese campo.
jsonName

string

Es el nombre JSON de este campo. El compilador de protocolos establece el valor. Si el usuario estableció un valor "jsonName" en este campo, se usará el valor de esa opción. De lo contrario, se deduce a partir del nombre del campo convirtiéndolo a camelCase.
proto3Optional

boolean

Si es verdadero, este es un proto3 "opcional". Cuando un campo proto3 es opcional, realiza un seguimiento de la presencia independientemente del tipo de campo.

Cuando proto3Optional es verdadero, este campo debe pertenecer a uno de los siguientes para indicar a los clientes de proto3 anteriores que se realiza un seguimiento de la presencia de este campo. Este se conoce como “sintético” uno de los campos y este debe ser su único miembro (cada campo opcional de proto3 tiene su propio uno sintético). Los oneofs sintéticos existen solo en el descriptor y no generan ninguna API. Los caracteres sintéticos deben ordenarse después de todos los caracteres “reales” es una de ellas.

Para los campos de mensaje, proto3Optional no crea ningún cambio semántico, ya que los campos de mensaje no repetidos siempre realizan un seguimiento de la presencia. Sin embargo, todavía indica el detalle semántico de si el usuario escribió "opcional". o no. Esto puede ser útil para recorrer el archivo .proto. Por motivos de coherencia, también otorgamos un campo sintético a los campos de mensaje, aunque no es necesario para realizar un seguimiento de la presencia. Esto es muy importante porque el analizador no puede saber si un campo es un mensaje o una enumeración, por lo que siempre debe crear uno sintético.

Los campos opcionales de Proto2 no configuran esta marca, porque ya indican que es opcional con LABEL_OPTIONAL.

Etiqueta

Enumeraciones
LABEL_OPTIONAL 0 se reserva para errores
LABEL_REPEATED
LABEL_REQUIRED La etiqueta obligatoria solo se permite en proto2. En proto3 y Editions, está explícitamente prohibido. En las ediciones, se puede usar la función fieldPresence para obtener este comportamiento.

Tipo

Enumeraciones
TYPE_DOUBLE 0 está reservado para errores. El orden es extraño por razones históricas.
TYPE_FLOAT
TYPE_INT64 No tiene codificación ZigZag. Los números negativos toman 10 bytes. Usa TYPE_SINT64 si es probable que los valores negativos sean.
TYPE_UINT64
TYPE_INT32 No tiene codificación ZigZag. Los números negativos toman 10 bytes. Usa TYPE_SINT32 si es probable que los valores negativos sean.
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP Agregado delimitado por etiquetas. El tipo de grupo está obsoleto y no es compatible después de proto2. Sin embargo, las implementaciones de Proto3 aún deberían poder analizar el formato de conexión de grupo y tratar los campos de grupo como campos desconocidos. En Ediciones, se puede habilitar el formato de transferencia de datos del grupo con la función messageEncoding.
TYPE_MESSAGE Agregado delimitado por longitud.
TYPE_BYTES Novedades de la versión 2.
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 Usa la codificación ZigZag.
TYPE_SINT64 Usa la codificación ZigZag.

EnumDescriptorProto

Describe un tipo de enumeración.

Representación JSON 
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
Campos
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

Describe un valor dentro de una enumeración.

Representación JSON 
{
  "name": string,
  "number": integer
}
Campos
name

string
number

integer

OneofDescriptorProto

Describe uno de los siguientes elementos.

Representación JSON 
{
  "name": string
}
Campos
name

string

PolicySchemaFieldDescription

Proporciona información detallada para un campo en particular que forma parte de PolicySchema.

Representación 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)
  }
}
Campos
field

string

Solo salida. El nombre del campo asociado con esta descripción.
description
(deprecated)

string

Obsoleta. En su lugar, usa name y fieldDescription. La descripción del campo.
inputConstraint

string

Solo salida. Cualquier restricción de entrada asociada a los valores del campo.
knownValueDescriptions[]

object (PolicySchemaFieldKnownValueDescription)

Solo salida. Si el campo tiene un conjunto de valores conocidos, este campo proporcionará una descripción para esos valores.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

Solo salida. Proporciona la descripción de los campos anidados en este campo, si el campo es de un tipo de mensaje que define varios campos. Se sugiere que los campos se muestren según el orden en esta lista y no por el número de campo.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Solo salida. Proporciona una lista de campos y valores. Al menos uno de los campos debe tener el valor correspondiente para que se pueda establecer este campo.
requiredItems[]

object (PolicySchemaRequiredItems)

Solo salida. Proporciona una lista de campos que se deben configurar si este campo tiene un valor determinado.
defaultValue

value (Value format)

Solo salida. Configuración predeterminada del cliente si no se establece la política.
name

string

Solo salida. El nombre del campo
fieldDescription

string

Solo salida. La descripción del campo.
fieldConstraints

object (FieldConstraints)

Solo salida. Información sobre las restricciones de entrada asociadas a los valores del campo.

PolicySchemaFieldKnownValueDescription

Proporciona información detallada sobre un valor conocido que está permitido para un campo particular en un PolicySchema.

Representación JSON 
{
  "value": string,
  "description": string,
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ]
}
Campos
value

string

Solo salida. La representación de cadena del valor que se puede establecer para el campo.
description

string

Solo salida. Es la descripción adicional de este valor.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Solo salida. Son las condiciones de campo obligatorias para que este valor sea válido.

PolicySchemaFieldDependencies

El campo y el valor que debe tener para que se pueda configurar otro campo.

Representación JSON 
{
  "sourceField": string,
  "sourceFieldValue": string
}
Campos
sourceField

string

El campo de origen del que depende este campo.
sourceFieldValue

string

Es el valor que debe tener el campo de origen para que se pueda configurar este campo.

PolicySchemaRequiredItems

Los campos que serán obligatorios según el valor de este campo.

Representación JSON 
{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}
Campos
fieldConditions[]

string

Los valores del campo que provocan la aplicación forzosa del campo obligatorio. Un fieldConditions vacío implica que cualquier valor asignado a este campo provocará la aplicación obligatoria del campo.
requiredFields[]

string

Son los campos que son obligatorios como consecuencia de las condiciones del campo.

FieldConstraints

Información sobre cualquier restricción de rango.

Representación JSON 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
Campos
numericRangeConstraint

object (NumericRangeConstraint)

El rango permitido para los campos numéricos.
uploadedFileConstraints

object (UploadedFileConstraints)

Las restricciones del archivo subido de una política de archivo Si está presente, esta política requiere una URL que se pueda recuperar subiendo un archivo con las restricciones especificadas en este proto.

NumericRangeConstraint

Una restricción en los límites superiores o inferiores, con al menos uno establecido.

Representación JSON 
{
  "minimum": string,
  "maximum": string
}
Campos
minimum

string (int64 format)

Valor mínimo.
maximum

string (int64 format)

Valor máximo

UploadedFileConstraints

Las restricciones del archivo subido de una política de archivo

Representación JSON 
{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}
Campos
supportedContentTypes[]

enum (ContentType)

Tipos de archivos que se pueden subir para un parámetro de configuración.
sizeLimitBytes

string (int64 format)

Es el límite, en bytes, de los archivos subidos para un parámetro de configuración.

ContentType

Tipos de archivos que se pueden subir para un parámetro de configuración.

Enumeraciones
CONTENT_TYPE_UNSPECIFIED Tipo de contenido sin especificar.
CONTENT_TYPE_PLAIN_TEXT Texto sin formato
CONTENT_TYPE_HTML HTML
CONTENT_TYPE_IMAGE_JPEG JPEG.
CONTENT_TYPE_IMAGE_GIF o GIF.
CONTENT_TYPE_IMAGE_PNG PNG.
CONTENT_TYPE_JSON JSON.
CONTENT_TYPE_ZIP Código postal
CONTENT_TYPE_GZIP GZIP.
CONTENT_TYPE_CSV CSV
CONTENT_TYPE_YAML YAML
CONTENT_TYPE_IMAGE_WEBP o WEBP.

PolicySchemaNoticeDescription

Proporciona mensajes de aviso especial relacionados con un valor particular en un campo que forma parte de un PolicySchema.

Representación JSON 
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
Campos
field

string

Solo salida. El nombre del campo asociado con el aviso.
noticeValue

string

Solo salida. El valor del campo que tiene un aviso. Cuando se configura el campo en este valor, es posible que el usuario deba confirmar el mensaje de aviso para establecer el valor.
noticeMessage

string

Solo salida. El mensaje de aviso asociado con el valor del campo.
acknowledgementRequired

boolean

Solo salida. Si el usuario debe confirmar o no el mensaje de aviso antes de que se pueda establecer el valor.

TargetResource

Tipos de recursos de destino

Enumeraciones
TARGET_RESOURCE_UNSPECIFIED Recurso de destino no especificado.
ORG_UNIT Recurso de destino de la unidad organizativa.
GROUP recurso de destino del grupo.

PolicyApiLifecycle

Información del ciclo de vida.

Representación JSON 
{
  "deprecatedInFavorOf": [
    string
  ],
  "scheduledToDeprecatePolicies": [
    string
  ],
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  }
}
Campos
deprecatedInFavorOf[]

string

En el caso de que esta política deje de estar disponible en favor de otra política, los espacios de nombres completamente calificados de las políticas nuevas como se mostrarán en PolicyAPI. Solo se puede configurar si policyApiLifecycleStage es API_DEPRECATED.
scheduledToDeprecatePolicies[]

string

Los espacios de nombres completamente calificados de las políticas anteriores que dejarán de estar disponibles debido a la introducción de esta política y corresponde a obsoletosInFavorOf.
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

Indica la etapa del ciclo de vida actual de la API de políticas.
description

string

Descripción del ciclo de vida actual.
endSupport

object (Date)

Fecha de finalización de la compatibilidad de la política actual. Si intentas modificar una política después de su fecha de finalización de la asistencia, se generará una solicitud incorrecta (error 400). Solo se puede configurar si policyApiLifecycleStage es API_DEPRECATED.

PolicyApiLifecycleEnum

Etapa del ciclo de vida de la API de la política.

Enumeraciones
API_UNSPECIFIED No se especificó el ciclo de vida de la API de Policy.
API_PREVIEW La política aún no funciona, pero les está dando aviso a los desarrolladores sobre el formato. Esta etapa se puede transferir a API_DESUPPORTMNT o API_CURRENT.
API_DEVELOPMENT La política puede cambiar de formato de manera incompatible con versiones anteriores (cambio rotundo). Esta etapa se puede transferir a API_CURRENT o API_DEPRECATED. Esto podría usarse en las políticas que se lanzan solo para TT o para clientes seleccionados para uso de emergencia.
API_CURRENT Política en formato oficial. La política puede cambiar de formato de manera retrocompatible (cambio no rotundo). Ejemplo: Esta política puede introducir un campo nuevo, que se considera un cambio no rotundo, cuando las máscaras de campo se usan correctamente. Esta etapa puede transferirse a API_DEPRECATED.
API_DEPRECATED Deja de usar esta política. Esta política dejó de estar disponible y es posible que se quite en el futuro. Lo más probable es que se haya introducido una política nueva para reemplazar a esta.

Fecha

Representa una fecha de calendario completa o parcial, como un cumpleaños. La hora del día y la zona horaria se especifican en otro lugar o son insignificantes. La fecha está relacionada con el calendario gregoriano. Puede representar una de las siguientes opciones:

  • Una fecha completa con valores para el año, mes y día que no sean cero.
  • Un mes y un día, con cero año (por ejemplo, un aniversario).
  • Un año por sí solo, con un mes cero y un día cero.
  • Es un año y un mes, con un día cero (por ejemplo, la fecha de vencimiento de una tarjeta de crédito).

Tipos relacionados:

Representación JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Año de la fecha. Debe ser entre 1 y 9,999, o bien 0 para especificar una fecha sin año.
month

integer

Mes del año. Debe ser del 1 al 12 o 0 para especificar un año sin un mes ni un día.
day

integer

Día del mes. Debe ser entre 1 y 31 y ser válido para el año y el mes o bien 0 para especificar un año solo o un año y un mes en los que el día no sea significativo.

Plataforma

Esta es una enumeración de los diferentes grupos de plataformas compatibles con Chrome.

Enumeraciones
PLATFORM_UNSPECIFIED Plataforma no especificada.
CHROME_OS ChromeOS.
CHROME_BROWSER Navegador Chrome para OSX, Windows o Linux.
CHROME_BROWSER_FOR_ANDROID Navegador Chrome para Android.
CHROME_BROWSER_FOR_IOS Navegador Chrome para iOS.

Métodos

get

 Obtén un esquema de política específico para un cliente por su nombre de recurso.

list

 Obtiene una lista de esquemas de políticas que coinciden con un valor de filtro especificado para un cliente determinado.