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 no 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 em questão.
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, a localização física, as datas de contratação ou qualquer outra informação que atenda às necessidades do seu negócio. 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 especificando se o campo tem vários valores. Padrão: false.
kind

string

O 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 administradores para mais informações.

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

Os valores aceitáveis são:

  • ADMINS_AND_SELF: somente 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 são aceitas para campos numéricos. A definição de numericIndexingSpec permite o suporte a consultas de intervalo.
numericIndexingSpec.minValue

number

Valor mínimo deste campo. Isso deve ser indicativo, e não aplicado. Valores fora desse intervalo ainda serão indexados, mas a pesquisa pode não ter um desempenho tão bom.
numericIndexingSpec.maxValue

number

Valor máximo deste campo. Isso deve ser indicativo, e não aplicado. Valores fora desse intervalo ainda serão indexados, mas a pesquisa pode 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 em um esquema.

update

 Atualiza um esquema.