REST Resource: schemas

משאב: סכימה

הסוג של משאב ה-API. למשאבים של Schema, הערך הוא תמיד admin#directory#schema.

ייצוג JSON 
{
  "schemaId": string,
  "schemaName": string,
  "fields": [
    {
      object (SchemaFieldSpec)
    }
  ],
  "displayName": string,
  "kind": string,
  "etag": string
}
שדות
schemaId

string

המזהה הייחודי של הסכימה (לקריאה בלבד)
schemaName

string

שם הסכימה.

כל schemaName חייב להיות ייחודי בתוך לקוח. שימוש חוזר בשם גורם לשגיאה 409: Entity already exists.
fields[]

object (SchemaFieldSpec)

רשימה של שדות בסכימה.
displayName

string

השם המוצג של הסכימה.
kind

string

סוג המשאב הזה.
etag

string

ה-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

string

שם השדה.
fieldId

string

המזהה הייחודי של השדה (לקריאה בלבד)
fieldType

string

סוג השדה.

הערכים הקבילים הם:

  • BOOL: ערכים בוליאניים.
  • DATE: תאריכים בפורמט ISO-8601.
  • DOUBLE: ערכי נקודות צפות עם דיוק כפול.
  • EMAIL: כתובות אימייל.
  • INT64: ערכי מספרים שלמים של 64 ביט.
  • PHONE: מספרי טלפון.
  • STRING: ערכי מחרוזת.
multiValued

boolean

ערך בוליאני שמציין אם זהו שדה בעל ערכים מרובים או לא. ברירת המחדל: false.
kind

string

סוג המשאב הזה. בשדות סכימה הערך הוא תמיד admin#directory#schema#fieldspec.
etag

string

ה-ETag של השדה.
indexed

boolean

ערך בוליאני שמציין אם השדה נוסף לאינדקס או לא. ברירת המחדל: true.
displayName

string

השם המוצג של השדה.
readAccessType

string

ההגדרה הזאת קובעת מי יכול לראות את הערכים בשדה הזה. מידע נוסף זמין במאמר אחזור משתמשים כמשתמשים שאינם מנהלי מערכת.

הערה: השינויים בשדה הזה יבואו לידי ביטוי תוך 24 שעות.

הערכים הקבילים הם:

  • ADMINS_AND_SELF: רק האדמינים והמשתמש המשויך יכולים לראות ערכים.
  • ALL_DOMAIN_USERS: כל משתמש בדומיין שלך יכול לראות ערכים.
numericIndexingSpec

object

מפרט ליצירת אינדקס עבור שדה מספרי. כברירת מחדל, רק שאילתות בהתאמה מדויקת יתמכו בשדות מספריים. ההגדרה numericIndexingSpec מאפשרת תמיכה בשאילתות טווח.
numericIndexingSpec.minValue

number

הערך המינימלי של השדה הזה. זו דוגמה בלבד. ערכים מחוץ לטווח הזה עדיין יתווספו לאינדקס, אבל ייתכן שהביצועים של החיפוש יהיו נמוכים יותר.
numericIndexingSpec.maxValue

number

הערך המקסימלי בשדה הזה. זו דוגמה בלבד. ערכים מחוץ לטווח הזה עדיין יתווספו לאינדקס, אבל ייתכן שהביצועים של החיפוש יהיו נמוכים יותר.

שיטות

delete

 מחיקת סכימה.

get

 מאחזר סכימה.

insert

 יוצר סכימה.

list

 מאחזר את כל הסכימות עבור לקוח.

patch

 מתקן סכימה.

update

 מעדכן סכימה.