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.

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

object (SchemaFieldSpec)

Eine Liste der Felder im Schema.
displayName

string

Anzeigename für das Schema.
kind

string

Der Ressourcentyp.
etag

string

Das ETag der Ressource.

SchemaFieldSpec

Sie können Schemas verwenden, um benutzerdefinierte Felder zu Nutzerprofilen hinzuzufügen. In diesen Feldern können Sie Informationen speichern, z. B. Projekte, an denen Ihre Nutzer arbeiten, ihren Standort, das Einstellungsdatum oder andere Daten, 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

Der Ressourcentyp. Für Schemafelder ist dies immer admin#directory#schema#fieldspec.
etag

string

Das ETag des Felds.
indexed

boolean

Boolescher Wert, der angibt, ob das Feld indexiert wird. Standardeinstellung: true.
displayName

string

Anzeigename des Felds.
readAccessType

string

Gibt an, wer die Werte dieses Felds sehen darf. Weitere Informationen finden Sie unter Nutzer als Nicht-Administrator abrufen.

Hinweis: Es kann bis zu 24 Stunden dauern, bis die Änderungen in diesem Feld übernommen 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 die Werte sehen.
numericIndexingSpec

object

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

number

Minimalwert dieses Felds. Dies soll lediglich als Anregung dienen und nicht zwingend durchgesetzt werden. Werte außerhalb dieses Bereichs werden zwar indexiert, aber die Suche ist möglicherweise nicht so leistungsfähig.
numericIndexingSpec.maxValue

number

Maximalwert dieses Felds. Dies soll lediglich als Anregung dienen und nicht zwingend durchgesetzt werden. Werte außerhalb dieses Bereichs werden zwar 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

 Patchet ein Patch.

update

 Aktualisiert ein Schema.