REST Resource: schemas

Ressource: Schema

Der Typ der API-Ressource. Bei Schemaressourcen ist dies immer admin#directory#schema.

JSON-Darstellung 
{
  "schemaId": string,
  "schemaName": string,
  "fields": [
    {
      object (SchemaFieldSpec)
    }
  ],
  "displayName": string,
  "kind": string,
  "etag": string
}
Felder
schemaId

string

Die eindeutige Kennung des Schemas (schreibgeschützt)
schemaName

string

Der Name des Schemas.

Jede schemaName muss innerhalb eines Kunden eindeutig sein. Die Wiederverwendung eines Namens führt zum Fehler 409: Entity already exists.
fields[]

object (SchemaFieldSpec)

Eine Liste der Felder im Schema.
displayName

string

Anzeigename für das Schema.
kind

string

Art der Ressource.
etag

string

Das ETag der Ressource.

SchemaFieldSpec

Mithilfe von Schemas können Sie Nutzerprofilen benutzerdefinierte Felder hinzufügen. In diesen Feldern können Sie Informationen wie die Projekte speichern, an denen Ihre Nutzer arbeiten, ihren Standort, ihr Einstellungsdatum oder andere Informationen, die Ihren geschäftlichen Anforderungen entsprechen. Weitere Informationen finden Sie unter Benutzerdefinierte Nutzerfelder.

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

string

Der Name des Felds.
fieldId

string

Die eindeutige Kennung des Felds (schreibgeschützt)
fieldType

string

Der Typ des Felds.

Akzeptable Werte sind:

  • BOOL: Boolesche Werte.
  • DATE: Datumsangaben im ISO-8601-Format.
  • DOUBLE: Gleitkommawerte mit doppelter Genauigkeit.
  • EMAIL: E-Mail-Adressen.
  • INT64: 64-Bit-Ganzzahlwerte.
  • PHONE: Telefonnummern.
  • STRING: Stringwerte.
multiValued

boolean

Ein boolescher Wert, der angibt, ob es sich um ein mehrwertiges Feld handelt. Standard: false.
kind

string

Die Art der Ressource. Bei Schemafeldern ist dies immer admin#directory#schema#fieldspec.
etag

string

Das ETag des Felds.
indexed

boolean

Boolescher Wert, der angibt, ob das Feld indexiert ist oder nicht. Standard: true.
displayName

string

Der Anzeigename des Felds.
readAccessType

string

Hier wird festgelegt, wer die Werte dieses Felds sehen kann. Weitere Informationen finden Sie unter Nutzer als Nichtadministrator abrufen.

Hinweis: Es kann bis zu 24 Stunden dauern, bis Änderungen an diesem Feld übernommen werden.

Akzeptable Werte sind:

  • ADMINS_AND_SELF: Nur Administratoren und der zugewiesene Nutzer können Werte sehen.
  • ALL_DOMAIN_USERS: Alle Nutzer in Ihrer Domain können Werte sehen.
numericIndexingSpec

object

Indexierungsspezifikation für ein numerisches Feld. Für numerische Felder werden standardmäßig nur Abfragen mit exakter Übereinstimmung unterstützt. Wenn Sie den numericIndexingSpec festlegen, werden Bereichsanfragen unterstützt.
numericIndexingSpec.minValue

number

Mindestwert dieses Felds. Dieser Wert dient lediglich als Richtwert. Werte außerhalb dieses Bereichs werden zwar weiterhin indexiert, die Suche ist aber möglicherweise nicht so leistungsfähig.
numericIndexingSpec.maxValue

number

Maximalwert dieses Felds. Dieser Wert dient lediglich als Richtwert. Werte außerhalb dieses Bereichs werden zwar weiterhin indexiert, die Suche ist aber möglicherweise nicht so leistungsfähig.

Methoden

delete

 Löscht ein Schema.

get

 Ruft ein Schema ab.

insert

 Erstellt ein Schema.

list

 Ruft alle Schemas für einen Kunden ab.

patch

 Patches ein Schema.

update

 Aktualisiert ein Schema.