Ressource: Schema
Der Typ der API-Ressource. Für Schemaressourcen ist dies immer admin#directory#schema
.
JSON-Darstellung |
---|
{
"schemaId": string,
"schemaName": string,
"fields": [
{
object ( |
Felder | |
---|---|
schemaId |
Die eindeutige ID des Schemas (schreibgeschützt) |
schemaName |
Der Name des Schemas. Jeder |
fields[] |
Eine Liste der Felder im Schema. |
displayName |
Anzeigename für das Schema. |
kind |
Der Ressourcentyp. |
etag |
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 |
Der Name des Felds. |
fieldId |
Die eindeutige ID des Felds (schreibgeschützt) |
fieldType |
Der Typ des Felds. Akzeptable Werte sind:
|
multiValued |
Boolescher Wert, der angibt, ob dies ein Feld mit mehreren Werten ist oder nicht. Standardeinstellung: |
kind |
Die Art der Ressource. Bei Schemafeldern ist dies immer |
etag |
Das ETag des Felds. |
indexed |
Boolescher Wert, der angibt, ob das Feld indexiert ist oder nicht. Standardeinstellung: |
displayName |
Anzeigename des Felds. |
readAccessType |
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:
|
numericIndexingSpec |
Indexierungsspezifikation für ein numerisches Feld. Standardmäßig werden für numerische Felder nur genau passende Suchanfragen unterstützt. Wenn |
numericIndexingSpec.minValue |
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 |
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 |
|
---|---|
|
Löscht ein Schema. |
|
Ruft ein Schema ab. |
|
Erstellt ein Schema. |
|
Ruft alle Schemas für einen Kunden ab. |
|
Patches ein Schema. |
|
Aktualisiert ein Schema. |