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: ערכים של נקודה צפה (floating-point) עם דיוק כפול.
  • 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

 עדכון של סכימה.