REST Resource: schemas

Recurso: Esquema

El tipo de recurso de API. Para los recursos de esquema, siempre es admin#directory#schema.

Representación JSON
{ "schemaId": string, "schemaName": string, "fields": [ { object (SchemaFieldSpec) } ], "displayName": string, "kind": string, "etag": string }

Campos
schemaId	string El identificador único del esquema (solo lectura)
schemaName	string El nombre del esquema. Cada schemaName debe ser único dentro de un cliente. Volver a usar un nombre da como resultado un error 409: Entity already exists.
fields[]	object (SchemaFieldSpec) Una lista de campos en el esquema.
displayName	string Nombre visible del esquema.
kind	string Es un recurso.
etag	string La ETag del recurso.

Especificación de SchemaField

Puedes usar esquemas para agregar campos personalizados a los perfiles de usuario. Puedes utilizar estos campos para almacenar información como los proyectos en los que trabajan los usuarios, sus ubicaciones físicas, las fechas de contratación o cualquier otra cosa que se adapte a las necesidades de tu empresa. Para obtener más información, consulta Campos de usuario personalizados.

Representación JSON
{ "fieldName": string, "fieldId": string, "fieldType": string, "multiValued": boolean, "kind": string, "etag": string, "indexed": boolean, "displayName": string, "readAccessType": string, "numericIndexingSpec": { "minValue": number, "maxValue": number } }

Campos
fieldName	string El nombre del campo
fieldId	string El identificador único del campo (solo lectura)
fieldType	string El tipo de campo. Los valores aceptables son: BOOL: Valores booleanos. DATE: Fechas en formato ISO-8601. DOUBLE: Valores de punto flotante de precisión doble. EMAIL: Direcciones de correo electrónico. INT64: Son valores enteros de 64 bits. PHONE: Números de teléfono. STRING: Valores de string
multiValued	boolean Un valor booleano que especifica si se trata de un campo con valores múltiples o no. Valor predeterminado: false.
kind	string El tipo de recurso es este. Para los campos de esquema, siempre es admin#directory#schema#fieldspec.
etag	string La ETag del campo.
indexed	boolean Booleano que especifica si el campo está indexado o no. Valor predeterminado: true.
displayName	string Nombre visible del campo.
readAccessType	string Especifica quién puede ver los valores de este campo. Consulta Cómo recuperar usuarios como no administradores para obtener más información. Nota: Es posible que los cambios en este campo tarden hasta 24 horas en reflejarse. Los valores aceptables son: ADMINS_AND_SELF: Solo los administradores y el usuario asociado pueden ver los valores. ALL_DOMAIN_USERS: Cualquier usuario de tu dominio puede ver los valores.
numericIndexingSpec	object Especificación de indexación para un campo numérico. De forma predeterminada, solo se admiten consultas de concordancia exacta para los campos numéricos. Si estableces numericIndexingSpec, se admitirán las consultas por rango.
numericIndexingSpec.minValue	number Valor mínimo de este campo. Su propósito es ser más orientativo que obligatorio. Los valores fuera de este rango se seguirán indexando, pero es posible que la búsqueda no tenga un rendimiento tan bueno.
numericIndexingSpec.maxValue	number Valor máximo de este campo. Su propósito es ser más orientativo que obligatorio. Los valores fuera de este rango se seguirán indexando, pero es posible que la búsqueda no tenga un rendimiento tan bueno.

Métodos
delete	Borra un esquema.
get	Recupera un esquema.
insert	Crea un esquema.
list	Recupera todos los esquemas para un cliente.
patch	Aplica parches a un esquema.
update	Actualiza un esquema.