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 של המשאב.

מפרט SchemaField

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

ייצוג 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

עדכון סכימה.