REST Resource: schemas

Ressource: Schema

Der Typ der API-Ressource. Für 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 ID des Schemas (schreibgeschützt)
schemaName

string

Der Name des Schemas.

Jeder schemaName darf innerhalb eines Kunden nur einmal vorkommen. 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

Der Ressourcentyp.
etag

string

Das ETag der Ressource.

SchemaFieldSpec

Sie können Schemas verwenden, um benutzerdefinierte Felder zu Nutzerprofilen hinzuzufügen. Sie können diese Felder verwenden, um Informationen wie die Projekte, an denen Ihre Nutzer arbeiten, ihre Standorte, ihre Einstellungsdaten oder andere Informationen zu speichern, 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 ID des Felds (schreibgeschützt)
fieldType

string

Der Typ des Felds.

Akzeptable Werte sind:

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

boolean

Boolescher Wert, der angibt, ob dies ein Feld mit mehreren Werten ist 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 im Hilfeartikel Nutzer ohne Administratorberechtigungen abrufen.

Hinweis: Es kann bis zu 24 Stunden dauern, bis Änderungen in diesem Feld angezeigt 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 Suchanfragen unterstützt. Wenn numericIndexingSpec festgelegt ist, können Bereichsabfragen unterstützt werden.
numericIndexingSpec.minValue

number

Mindestwert dieses Felds. Dies ist lediglich als Richtwert gedacht und nicht zwingend durchgesetzt. Werte außerhalb dieses Bereichs werden zwar indexiert, die Suche ist jedoch möglicherweise nicht so leistungsstark.
numericIndexingSpec.maxValue

number

Höchstwert dieses Felds. Dies ist lediglich als Richtwert gedacht und nicht zwingend durchgesetzt. Werte außerhalb dieses Bereichs werden zwar indexiert, die Suche ist jedoch möglicherweise nicht so leistungsstark.

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.