REST Resource: schemas

Recurso: Schema

Es el tipo de recurso de la 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. Cuando se vuelve a usar un nombre, se genera un error 409: Entity already exists.

fields[]

object (SchemaFieldSpec)

Una lista de campos en el esquema.

displayName

string

Es el nombre visible del esquema.

kind

string

Este es el tipo de recurso.

etag

string

La ETag del recurso

SchemaFieldSpec

Puedes usar esquemas para agregar campos personalizados a los perfiles de usuario. Puede utilizar estos campos para almacenar información como los proyectos en los que trabajan los usuarios, sus ubicaciones físicas, sus fechas de contratación o cualquier otro dato que se ajuste a las necesidades de su 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 del 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

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

Es un valor 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. Para obtener más información, consulta Recuperar usuarios como no administradores.

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 consultas de concordancia exacta para los campos numéricos. Si estableces numericIndexingSpec, se admitirán las consultas de rango.

numericIndexingSpec.minValue

number

Valor mínimo de este campo. El propósito de esto es ser indicativo y no obligatorio. Los valores fuera de este rango se indexarán, pero es posible que la búsqueda no tenga el mismo rendimiento.

numericIndexingSpec.maxValue

number

Valor máximo de este campo. El propósito de esto es ser indicativo y no obligatorio. 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.