משאב: סכימה
הסוג של משאב ה-API. למשאבים של Schema, הערך הוא תמיד admin#directory#schema
.
ייצוג JSON |
---|
{
"schemaId": string,
"schemaName": string,
"fields": [
{
object ( |
שדות | |
---|---|
schemaId |
המזהה הייחודי של הסכימה (לקריאה בלבד) |
schemaName |
שם הסכימה. כל |
fields[] |
רשימה של שדות בסכימה. |
displayName |
השם המוצג של הסכימה. |
kind |
סוג המשאב הזה. |
etag |
ה-ETag של המשאב. |
SchemaFieldSpec
אפשר להשתמש בסכימות כדי להוסיף שדות מותאמים אישית לפרופילים של משתמשים. תוכלו להשתמש בשדות האלה כדי לאחסן מידע כגון הפרויקטים שהמשתמשים שלכם עובדים עליהם, המיקומים הפיזיים שלהם, תאריכי ההעסקה שלהם או כל מידע אחר שמתאים לצרכי העסק שלכם. מידע נוסף זמין במאמר שדות משתמש בהתאמה אישית.
ייצוג JSON |
---|
{ "fieldName": string, "fieldId": string, "fieldType": string, "multiValued": boolean, "kind": string, "etag": string, "indexed": boolean, "displayName": string, "readAccessType": string, "numericIndexingSpec": { "minValue": number, "maxValue": number } } |
שדות | |
---|---|
fieldName |
שם השדה. |
fieldId |
המזהה הייחודי של השדה (לקריאה בלבד) |
fieldType |
סוג השדה. הערכים הקבילים הם:
|
multiValued |
ערך בוליאני שמציין אם זהו שדה בעל ערכים מרובים או לא. ברירת המחדל: |
kind |
סוג המשאב הזה. בשדות סכימה הערך הוא תמיד |
etag |
ה-ETag של השדה. |
indexed |
ערך בוליאני שמציין אם השדה נוסף לאינדקס או לא. ברירת המחדל: |
displayName |
השם המוצג של השדה. |
readAccessType |
ההגדרה הזאת קובעת מי יכול לראות את הערכים בשדה הזה. מידע נוסף זמין במאמר אחזור משתמשים כמשתמשים שאינם מנהלי מערכת. הערה: השינויים בשדה הזה יבואו לידי ביטוי תוך 24 שעות. הערכים הקבילים הם:
|
numericIndexingSpec |
מפרט ליצירת אינדקס עבור שדה מספרי. כברירת מחדל, רק שאילתות בהתאמה מדויקת יתמכו בשדות מספריים. ההגדרה |
numericIndexingSpec.minValue |
הערך המינימלי של השדה הזה. זו דוגמה בלבד. ערכים מחוץ לטווח הזה עדיין יתווספו לאינדקס, אבל ייתכן שהביצועים של החיפוש יהיו נמוכים יותר. |
numericIndexingSpec.maxValue |
הערך המקסימלי בשדה הזה. זו דוגמה בלבד. ערכים מחוץ לטווח הזה עדיין יתווספו לאינדקס, אבל ייתכן שהביצועים של החיפוש יהיו נמוכים יותר. |
שיטות |
|
---|---|
|
מחיקת סכימה. |
|
מאחזר סכימה. |
|
יוצר סכימה. |
|
מאחזר את כל הסכימות עבור לקוח. |
|
מתקן סכימה. |
|
מעדכן סכימה. |