REST Resource: schemas

Recurso: Esquema

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

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

string

Es el identificador único del esquema (de solo lectura).
schemaName

string

Es el nombre del esquema.

Cada schemaName debe ser único dentro de un cliente. Si vuelves a usar un nombre, se produce un error 409: Entity already exists.
fields[]

object (SchemaFieldSpec)

Es una lista de campos en el esquema.
displayName

string

Es el nombre visible del esquema.
kind

string

Indica el tipo de recurso.
etag

string

La ETag del recurso.

SchemaFieldSpec

Puedes usar esquemas para agregar campos personalizados a los perfiles de usuario. Puedes usar estos campos para almacenar información como los proyectos en los que trabajan tus usuarios, sus ubicaciones físicas, sus fechas de contratación o cualquier otra información 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

Es el tipo de campo.

Los valores aceptables son:

  • BOOL: Valores booleanos.
  • DATE: Fechas en formato ISO-8601.
  • DOUBLE: Valores de punto flotante de doble precisión.
  • EMAIL: Direcciones de correo electrónico
  • INT64: Valores enteros de 64 bits.
  • PHONE: Números de teléfono.
  • STRING: Valores de cadena.
multiValued

boolean

Es un valor booleano que especifica si este es un campo de varios valores 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

Es un valor booleano que especifica si el campo está indexado o no. Valor predeterminado: true.
displayName

string

Es el nombre visible del campo.
readAccessType

string

Especifica quién puede ver los valores de este campo. Consulta Cómo recuperar usuarios como usuario no administrador para obtener más información.

Nota: Los cambios en este campo pueden tardar 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 admitirán las consultas de concordancia exacta para los campos numéricos. Configurar el numericIndexingSpec permite que se admitan las consultas por rango.
numericIndexingSpec.minValue

number

Es el valor mínimo de este campo. El objetivo de esto es ser indicativo, no aplicado. Los valores fuera de este rango se indexarán de todos modos, pero es posible que la búsqueda no tenga el mismo rendimiento.
numericIndexingSpec.maxValue

number

Valor máximo de este campo. El objetivo de esto es ser indicativo, no aplicado. Los valores fuera de este rango se indexarán, pero es posible que la búsqueda no tenga el mismo rendimiento.

Métodos

delete

 Borra un esquema.

get

 Recupera un esquema.

insert

 Crea un esquema.

list

 Recupera todos los esquemas de un cliente.

patch

 Aplica parches a un esquema.

update

 Actualiza un esquema.