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

 עדכון סכימה.