Recurso: Schema
O tipo de recurso de 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 em questão. |
etag |
A ETag do recurso. |
SchemaFieldSpec
É 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 os usuários trabalham, a localização física, as datas de contratação ou qualquer outra informação que satisfaça as necessidades da 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 aceitos são:
|
multiValued |
É um booleano especificando se o 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 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 mudanças neste campo sejam aplicadas. Os valores aceitos são:
|
numericIndexingSpec |
Especificação de indexação para um campo numérico. Por padrão, somente as consultas de correspondência exata são compatíveis com campos numéricos. Definir o |
numericIndexingSpec.minValue |
Valor mínimo deste campo. Isso deve ser apenas ilustrativo, e não obrigatório. Valores fora desse intervalo ainda serão indexados, mas a pesquisa talvez não tenha um desempenho tão bom. |
numericIndexingSpec.maxValue |
Valor máximo deste campo. Isso deve ser apenas ilustrativo, e não obrigatório. Valores fora desse intervalo ainda serão indexados, mas a pesquisa talvez não tenha um desempenho tão bom. |
Métodos |
|
---|---|
|
Exclui um esquema. |
|
Recupera um esquema. |
|
Cria um esquema. |
|
Recupera todos os esquemas de um cliente. |
|
Aplica patches em um esquema. |
|
Atualiza um esquema. |