סיכום הסוג והפורמט
כדי לקבוע את סוג הנתונים של הנכס, אפשר להשתמש בנכסי type
ו-format
בפרמטרים ובסכימות. הנכס type
מציין את סוג הנכס כשהוא נשלח בבקשות ובתגובות JSON (JSON תומך בקבוצה קטנה של סוגי נתונים, פרטים נוספים זמינים בכתובת json.org). המאפיין format
מספק מידע נוסף על סוג הבסיס. לנכסים תמיד יהיה נכס type
, אבל ייתכן גם שלחלקם יהיה נכס format
.
לדוגמה, לא ניתן לייצג מספר שלם ב-64 ביט ב-JSON (כי הוא תומך במספרים שלמים עד 2^53 של JavaScript). לכן, מספר שלם ב-64 ביט צריך להיות מיוצג כמחרוזת בבקשות/תגובות ב-JSON. לכן המאפיין type
יוגדר כ-"string", אבל המאפיין format
יוגדר כ-"int64" כדי לציין שהוא מספר שלם ב-64 ביט.
המפרט של סכימת JSON כבר מגדיר קבוצה של ערכים נפוצים בנכס ה-format
. שירות Google APIs Discovery תומך בחלק מהערכים האלה, ומגדיר גם אחרים. רשימת הערכים המלאה של type
ושל format
שנתמכת על ידי שירות Discovery של Google APIs מסוכמת בהמשך.
ערך הסוג | ערך פורמט | משמעות |
---|---|---|
any |
|
ניתן להשתמש בכל סוג בנכס. מוגדר לפי מפרט סכימת ה-JSON. |
array |
|
מערך JavaScript של ערכים. המאפיין items מציין את הסכימה של ערכי המערך. מוגדר לפי מפרט סכימת ה-JSON. |
boolean |
|
ערך בוליאני, "true" או "false". מוגדר לפי מפרט סכימת ה-JSON. |
integer |
int32 |
מספר שלם חתום של 32 ביט. הערך המינימלי שלו הוא -2,147,483,648 והערך המקסימלי הוא 2,147,483,647. |
integer |
uint32 |
מספר שלם ללא סימן (unsigned integer) של 32 סיביות. הערך המינימלי שלו הוא 0 והערך המקסימלי הוא 4,294,967,295 (כולל). |
number |
double |
נקודת צף כפולה מסוג IEEE 754 של דיוק 64 ביט. |
number |
float |
נקודה צפה אחת ב-32 ביט של דיוק IEEE 754. |
object |
|
אובייקט JavaScript. מוגדר לפי מפרט סכימת ה-JSON. |
string |
|
מחרוזת שרירותית. מוגדר לפי מפרט סכימת ה-JSON. |
string |
byte |
מחרוזת מרופדת של בייטים בקידוד base64, שמקודדת עם כתובת URL ועם אלפבית בטוח של שם קובץ (לפעמים נקרא "web-safe" או "base64url"). מוגדר על ידי RFC4648. |
string |
date |
תאריך RFC3339 בפורמט YYYY-MM-DD. מוגדר במפרט סכימת ה-JSON. |
string |
date-time |
חותמת זמן של RFC3339 בזמן UTC. פורמט זה הוא yyyy-MM-ddTHH:mm:ss.SSSZ. החלק האלפיות השנייה (".SSS") הוא אופציונלי. מוגדר במפרט סכימת ה-JSON. |
string |
google-datetime |
חותמת זמן של RFC3339 בזמן UTC. פורמט זה הוא yyyy-MM-ddTHH:mm:ss.SSSZ. החלק האלפיות השנייה (".SSS") הוא אופציונלי. |
string |
google-duration |
מחרוזת מסתיימת בסיומת "s" (מציינת שניות) ולפניה מספר שניות, כאשר ננו-שניות מסומנות בשניות. הנקודה משמשת תמיד כנקודה עשרונית, ולא כפסיק. |
string |
google-fieldmask |
מחרוזת שבה שמות השדות מופרדים בפסיקים. שמות השדות מיוצגים במוסכמה של שמות גמלים נמוכים. |
string |
int64 |
מספר שלם חתום של 64 ביט. הערך המינימלי שלו הוא -9,223,372,036,854,775,808 והערך המקסימלי שלו הוא 9,223,372,036,854,775,807. |
string |
uint64 |
מספר שלם ללא סימן (unsigned integer) של 64 סיביות. הערך המינימלי הוא 0 והערך המקסימלי הוא 2-64 (כולל). |