REST Resource: schemas

Recurso: esquema

O tipo de recurso da API. Para recursos de esquema, é sempre admin#directory#schema.

Representação JSON 
{
  "schemaId": string,
  "schemaName": string,
  "fields": [
    {
      object (SchemaFieldSpec)
    }
  ],
  "displayName": string,
  "kind": string,
  "etag": string
}
Campos
schemaId

string

O identificador exclusivo do esquema (somente leitura)
schemaName

string

O nome do esquema.

Cada schemaName precisa ser exclusivo para um cliente. A reutilização de um nome resulta em um erro 409: Entity already exists.
fields[]

object (SchemaFieldSpec)

Uma lista de campos no esquema.
displayName

string

Nome de exibição do esquema.
kind

string

Tipo de recurso.
etag

string

A ETag do recurso.

SchemaFieldSpec

É possível usar esquemas para adicionar campos personalizados aos perfis de usuário. Você pode usar esses campos para armazenar informações como os projetos em que os usuários trabalham, as localizações físicas, as datas de contratação ou qualquer outra coisa que se encaixe nas necessidades da sua empresa. Para mais informações, consulte Campos de usuário personalizados.

Representação 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

Nome do campo.
fieldId

string

O identificador exclusivo do campo (somente leitura)
fieldType

string

Tipo do campo.

Os valores aceitáveis são:

  • BOOL: valores booleanos.
  • DATE: datas no formato ISO-8601.
  • DOUBLE: valores de ponto flutuante de precisão dupla.
  • EMAIL: endereços de e-mail.
  • INT64: valores inteiros de 64 bits.
  • PHONE: números de telefone.
  • STRING: valores de string.
multiValued

boolean

Um booleano que especifica se este é um campo com vários valores ou não. Padrão: false.
kind

string

O tipo de recurso. Para campos de esquema, esse valor é sempre admin#directory#schema#fieldspec.
etag

string

A ETag do campo.
indexed

boolean

Booleano que especifica se o campo está indexado ou não. Padrão: true.
displayName

string

Nome de exibição do campo.
readAccessType

string

Especifica quem pode acessar os valores desse campo. Consulte Extrair usuários como não administrador para mais informações.

Observação: pode levar até 24 horas para que as mudanças neste campo sejam refletidas.

Os valores aceitáveis são:

  • ADMINS_AND_SELF: somente administradores e o usuário associado podem conferir os valores.
  • ALL_DOMAIN_USERS: qualquer usuário no seu domínio pode conferir os valores.
numericIndexingSpec

object

Especificação de indexação para um campo numérico. Por padrão, apenas as consultas de correspondência exata são compatíveis com campos numéricos. A configuração de numericIndexingSpec permite que as consultas de intervalo sejam compatíveis.
numericIndexingSpec.minValue

number

Valor mínimo desse campo. Essa é uma indicação, não uma regra. Os valores fora desse intervalo ainda serão indexados, mas a pesquisa pode não ter a mesma performance.
numericIndexingSpec.maxValue

number

Valor máximo desse campo. Essa é uma indicação, não uma regra. Os valores fora desse intervalo ainda serão indexados, mas a pesquisa pode não ter a mesma performance.

Métodos

delete

 Exclui um esquema.

get

 Recupera um esquema.

insert

 Cria um esquema.

list

 Recupera todos os esquemas de um cliente.

patch

 Adiciona patches a um esquema.

update

 Atualiza um esquema.