REST Resource: schemas

Risorsa: schema

Il tipo di risorsa API. Per le risorse schema, il valore è sempre admin#directory#schema.

Rappresentazione JSON 
{
  "schemaId": string,
  "schemaName": string,
  "fields": [
    {
      object (SchemaFieldSpec)
    }
  ],
  "displayName": string,
  "kind": string,
  "etag": string
}
Campi
schemaId

string

L'identificatore univoco dello schema (sola lettura)
schemaName

string

Il nome dello schema.

Ogni schemaName deve essere univoco all'interno di un cliente. Il riutilizzo di un nome genera un errore 409: Entity already exists.
fields[]

object (SchemaFieldSpec)

Un elenco di campi nello schema.
displayName

string

Nome visualizzato dello schema.
kind

string

Il tipo di risorsa.
etag

string

L'ETag della risorsa.

SchemaFieldSpec

Puoi utilizzare gli schemi per aggiungere campi personalizzati ai profili utente. Puoi utilizzare questi campi per archiviare informazioni quali i progetti su cui lavorano gli utenti, le loro posizioni fisiche, le date di assunzione o qualsiasi altra cosa possa soddisfare le tue esigenze aziendali. Per ulteriori informazioni, consulta Campi utente personalizzati.

Rappresentazione JSON 
{
  "fieldName": string,
  "fieldId": string,
  "fieldType": string,
  "multiValued": boolean,
  "kind": string,
  "etag": string,
  "indexed": boolean,
  "displayName": string,
  "readAccessType": string,
  "numericIndexingSpec": {
    "minValue": number,
    "maxValue": number
  }
}
Campi
fieldName

string

Il nome del campo.
fieldId

string

L'identificatore univoco del campo (sola lettura)
fieldType

string

Il tipo di campo.

I valori accettati sono:

  • BOOL: valori booleani.
  • DATE: le date nel formato ISO-8601.
  • DOUBLE: valori con rappresentazione in virgola mobile a precisione doppia.
  • EMAIL: indirizzi email.
  • INT64: valori interi a 64 bit.
  • PHONE: numeri di telefono.
  • STRING: valori stringa.
multiValued

boolean

Un valore booleano che specifica se si tratta o meno di un campo a più valori. Valore predefinito: false.
kind

string

Il tipo di risorsa. Per i campi dello schema, il valore è sempre admin#directory#schema#fieldspec.
etag

string

L'ETag del campo.
indexed

boolean

Valore booleano che specifica se il campo è indicizzato o meno. Valore predefinito: true.
displayName

string

Nome visualizzato del campo.
readAccessType

string

Specifica chi può visualizzare i valori di questo campo. Per ulteriori informazioni, consulta Recuperare gli utenti come non amministratore.

Nota: l'applicazione delle modifiche a questo campo può richiedere fino a 24 ore.

I valori accettati sono:

  • ADMINS_AND_SELF: solo gli amministratori e l'utente associato possono visualizzare i valori.
  • ALL_DOMAIN_USERS: qualsiasi utente nel tuo dominio può visualizzare i valori.
numericIndexingSpec

object

Specifiche di indicizzazione per un campo numerico. Per impostazione predefinita, per i campi numerici sono supportate solo le query a corrispondenza esatta. L'impostazione di numericIndexingSpec consente il supporto delle query di intervallo.
numericIndexingSpec.minValue

number

Valore minimo di questo campo. Questo è inteso a scopo indicativo anziché applicato. I valori al di fuori di questo intervallo verranno comunque indicizzati, ma il rendimento della ricerca potrebbe essere inferiore.
numericIndexingSpec.maxValue

number

Valore massimo di questo campo. Questo è inteso a scopo indicativo anziché applicato. I valori al di fuori di questo intervallo verranno comunque indicizzati, ma il rendimento della ricerca potrebbe essere inferiore.

Metodi

delete

 Elimina uno schema.

get

 Recupera uno schema.

insert

 Crea uno schema.

list

 Recupera tutti gli schemi per un cliente.

patch

 Applica patch a uno schema.

update

 Aggiorna uno schema.