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 ( |
Campos | |
---|---|
schemaId |
O identificador exclusivo do esquema (somente leitura) |
schemaName |
O nome do esquema. Cada |
fields[] |
Uma lista de campos no esquema. |
displayName |
Nome de exibição do esquema. |
kind |
Tipo de recurso. |
etag |
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, os locais físicos, 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 |
Nome do campo. |
fieldId |
O identificador exclusivo do campo (somente leitura) |
fieldType |
Tipo do campo. Os valores aceitáveis são:
|
multiValued |
Um booleano que especifica se este é um campo com vários valores ou não. Padrão: |
kind |
O tipo de recurso. Para campos de esquema, é sempre |
etag |
A ETag do campo. |
indexed |
Booleano que especifica se o campo está indexado ou não. Padrão: |
displayName |
Nome de exibição do campo. |
readAccessType |
Especifica quem pode acessar os valores desse campo. Consulte Recuperar usuários como não administradores 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:
|
numericIndexingSpec |
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 configuração de |
numericIndexingSpec.minValue |
Valor mínimo desse campo. Isso deve ser indicativo, e não aplicado. Os valores fora desse intervalo ainda serão indexados, mas a pesquisa pode não ter a mesma performance. |
numericIndexingSpec.maxValue |
Valor máximo deste 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 |
|
---|---|
|
Exclui um esquema. |
|
Recupera um esquema. |
|
Cria um esquema. |
|
Recupera todos os esquemas de um cliente. |
|
Adiciona patches a um esquema. |
|
Atualiza um esquema. |