הצגת מידע על זמן פנוי/לא פנוי בקבוצת יומנים. רוצים לנסות עכשיו?
בקשה
בקשת HTTP
POST https://www.googleapis.com/calendar/v3/freeBusy
הרשאות
הבקשה הזו מאפשרת הרשאה עם אחד מההיקפים הבאים לפחות:
היקף |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
מידע נוסף זמין בדף אימות והרשאה.
גוף הבקשה
בגוף הבקשה, מספקים נתונים במבנה הבא:
{ "timeMin": datetime, "timeMax": datetime, "timeZone": string, "groupExpansionMax": integer, "calendarExpansionMax": integer, "items": [ { "id": string } ] }
שם הנכס | Value | התיאור | הערות |
---|---|---|---|
timeMin |
datetime |
תחילת המרווח בשאילתה לפי RFC3339. | |
timeMax |
datetime |
סוף המרווח בשאילתה, בפורמט שתואם ל-RFC3339. | |
timeZone |
string |
אזור הזמן שמוגדר בתשובה. אפשרות. ברירת המחדל היא לפי שעון UTC. | |
groupExpansionMax |
integer |
המספר המקסימלי של מזהי יומנים שיש לספק לקבוצה אחת. אפשרות. מוחזרת שגיאה עבור קבוצה שיש בה יותר חברים מהערך הזה. הערך המקסימלי הוא 100. | |
calendarExpansionMax |
integer |
המספר המקסימלי של יומנים שעבורם יש לספק מידע על FreeBusy. אפשרות. הערך המקסימלי הוא 50. | |
items[] |
list |
רשימת יומנים ו/או קבוצות לביצוע שאילתות. | |
items[].id |
string |
המזהה של יומן או של קבוצה. |
תשובה
אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה גוף תגובה במבנה הבא:
{ "kind": "calendar#freeBusy", "timeMin": datetime, "timeMax": datetime, "groups": { (key): { "errors": [ { "domain": string, "reason": string } ], "calendars": [ string ] } }, "calendars": { (key): { "errors": [ { "domain": string, "reason": string } ], "busy": [ { "start": datetime, "end": datetime } ] } } }
שם הנכס | Value | התיאור | הערות |
---|---|---|---|
kind |
string |
סוג המשאב ("calendar#freeBusy"). | |
timeMin |
datetime |
תחילת המרווח. | |
timeMax |
datetime |
סוף המרווח. | |
groups |
object |
הרחבת קבוצות. | |
groups.(key) |
nested object |
רשימת היומנים שחברים בקבוצה הזו. | |
groups.(key).errors[] |
list |
שגיאות אופציונליות (אם חישוב הקבוצה נכשל). | |
groups.(key).errors[].domain |
string |
הדומיין, או הקטגוריה הרחבה, של השגיאה. | |
groups.(key).errors[].reason |
string |
סיבה ספציפית לשגיאה. הנה כמה מהערכים האפשריים:
|
|
groups.(key).calendars[] |
list |
רשימת המזהים של יומנים בתוך קבוצה. | |
calendars |
object |
רשימת פנוי/עסוק ביומנים. | |
calendars.(key) |
nested object |
הרחבות של 'פנוי/עסוק' ליומן יחיד. | |
calendars.(key).errors[] |
list |
שגיאות אופציונליות (אם חישוב היומן נכשל). | |
calendars.(key).errors[].domain |
string |
הדומיין, או הקטגוריה הרחבה, של השגיאה. | |
calendars.(key).errors[].reason |
string |
סיבה ספציפית לשגיאה. הנה כמה מהערכים האפשריים:
|
|
calendars.(key).busy[] |
list |
רשימה של טווחי הזמנים שבהם יש להתייחס ליומן הזה כעסוק. | |
calendars.(key).busy[].start |
datetime |
ההתחלה (כוללת) של תקופת הזמן. | |
calendars.(key).busy[].end |
datetime |
סוף תקופת הזמן (לא כולל). |
רוצה לנסות?
ניתן להשתמש ב-APIs Explorer שבהמשך כדי לקרוא לשיטה הזו בנתונים בזמן אמת ולראות את התגובה.