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.

Jedes schemaName muss innerhalb eines Kunden eindeutig sein. Das Wiederverwenden eines Namens führt zu einem 409: Entity already exists-Fehler.
fields[]

object (SchemaFieldSpec)

Eine Liste von Feldern im Schema.
displayName

string

Anzeigename für das Schema.
kind

string

Der Ressourcentyp.
etag

string

Das ETag der Ressource.

SchemaFieldSpec

Mithilfe von Schemas können Sie Nutzerprofilen benutzerdefinierte Felder hinzufügen. Sie können diese Felder verwenden, um Informationen wie die Projekte zu speichern, an denen Ihre Nutzer arbeiten, ihre physischen Standorte, ihre Einstellungsdaten oder andere Informationen, die Ihren Geschäftsanforderungen 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 Feld mit mehreren Werten handelt oder nicht. Standardeinstellung: 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. Standardeinstellung: true.
displayName

string

Anzeigename des Felds.
readAccessType

string

Gibt an, wer Werte dieses Felds ansehen kann. Weitere Informationen finden Sie unter Nutzer ohne Administratorberechtigungen abrufen.

Hinweis: Es kann bis zu 24 Stunden dauern, bis Änderungen in diesem Feld wirksam werden.

Akzeptable Werte sind:

  • ADMINS_AND_SELF: Nur Administratoren und der zugehörige Nutzer können Werte sehen.
  • ALL_DOMAIN_USERS: Jeder Nutzer in Ihrer Domain kann Werte sehen.
numericIndexingSpec

object

Indexierungsspezifikation für ein numerisches Feld. Standardmäßig werden für numerische Felder nur genau passende Abfragen unterstützt. Wenn numericIndexingSpec festgelegt ist, können Bereichsabfragen unterstützt werden.
numericIndexingSpec.minValue

number

Minimalwert dieses Felds. Dies ist ein Richtwert, nicht durchgesetzt. Werte außerhalb dieses Bereichs werden weiterhin indexiert, aber die Suche ist möglicherweise nicht so leistungsfähig.
numericIndexingSpec.maxValue

number

Der Maximalwert dieses Felds. Dies ist ein Richtwert, nicht durchgesetzt. Werte außerhalb dieses Bereichs werden weiterhin indexiert, aber die Suche ist 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

 Patcht ein Schema.

update

 Aktualisiert ein Schema.