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 em 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

Que tipo de recurso é esse.
etag

string

A ETag do recurso.

SpecFieldSpec

É possível usar esquemas para adicionar campos personalizados a perfis de usuário. É possível usar esses campos para armazenar informações como os projetos em que seus usuários trabalham, as localizações físicas, as datas de contratação ou o que mais atenda às necessidades da sua empresa. Para mais informações, consulte Campos personalizados do usuário.

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 aceitos 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 esse é um campo de vários valores. Padrão: false.
kind

string

Que tipo de recurso é. Para campos de esquema, é 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 ver os valores deste campo. Consulte Recuperar usuários como não administrador para mais informações.

Observação: pode levar até 24 horas para que as alterações nesse campo sejam aplicadas.

Os valores aceitos são:

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

object

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

number

Valor mínimo deste campo. Isso é apenas indicativo, e não obrigatório. Os valores fora desse intervalo ainda serão indexados, mas a pesquisa não terá um desempenho tão bom.
numericIndexingSpec.maxValue

number

Valor máximo deste campo. Isso é apenas indicativo, e não obrigatório. Os valores fora desse intervalo ainda serão indexados, mas a pesquisa não terá um desempenho tão bom.

Métodos

delete

 Exclui um esquema.

get

 Recupera um esquema.

insert

 Cria um esquema.

list

 Recupera todos os esquemas de um cliente.

patch

 Aplica patch a um esquema.

update

 Atualiza um esquema.