Freebusy: query

הפונקציה מחזירה מידע על זמן פנוי/לא פנוי של קבוצת יומנים. רוצים לנסות?

בקשה

בקשת HTTP

POST https://www.googleapis.com/calendar/v3/freeBusy

אישור

הבקשה הזו מאפשרת הרשאה עם לפחות אחד מההיקפים הבאים:

היקף
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events.freebusy
https://www.googleapis.com/auth/calendar.freebusy

מידע נוסף זמין בדף אימות והרשאה.

גוף הבקשה

בגוף הבקשה, מספקים נתונים במבנה הבא:

{
  "timeMin": datetime,
  "timeMax": datetime,
  "timeZone": string,
  "groupExpansionMax": integer,
  "calendarExpansionMax": integer,
  "items": [
    {
      "id": string
    }
  ]
}
שם הנכס ערך תיאור הערות
timeMin datetime תחילת התקופה של השאילתה בפורמט שמוגדר לפי RFC3339.
timeMax datetime סוף התקופה של השאילתה בפורמט לפי RFC3339.
timeZone string אזור הזמן שבו נעשה שימוש בתשובה. זה שינוי אופציונלי. ברירת המחדל היא UTC.
groupExpansionMax integer המספר המקסימלי של מזהי יומנים שאפשר לספק לקבוצה אחת. זה שינוי אופציונלי. אם מספר החברים בקבוצה גבוה מהערך הזה, תוחזר שגיאה. הערך המקסימלי הוא 100.
calendarExpansionMax integer המספר המקסימלי של יומנים שעבורם צריך לספק מידע על זמן פנוי/לא פנוי. זה שינוי אופציונלי. הערך המקסימלי הוא 50.
items[] list רשימת היומנים ו/או הקבוצות שרוצים לשלוח להם שאילתה.
items[].id string המזהה של יומן או קבוצה.

תשובה

אם הפעולה בוצעה ללא שגיאות, ה-method מחזיר גוף תגובה עם המבנה הבא:

{
  "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
        }
      ]
    }
  }
}
שם הנכס ערך תיאור הערות
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 הסיבה הספציפית לשגיאה. אלה כמה מהערכים האפשריים:
  • 'groupTooBig' – קבוצת המשתמשים המבוקשת גדולה מדי לשאילתה אחת.
  • 'tooManyCalendarsRequested' – מספר היומנים המבוקשים גדול מדי לשאילתה אחת.
  • 'notFound' – המשאב המבוקש לא נמצא.
  • 'internalError' – שירות ה-API נתקל בשגיאה פנימית.
יכול להיות שסוגי שגיאות נוספים יתווספו בעתיד, לכן הלקוחות צריכים לטפל בצורה תקינה בסטטוסים נוספים של שגיאות שלא נכללים ברשימה הזו.
groups.(key).calendars[] list רשימה של מזהי היומנים בקבוצה.
calendars object רשימת נתוני 'פנוי/עסוק' של יומנים.
calendars.(key) nested object הרחבות של סטטוס 'פנוי'/'עסוק' ביומן אחד.
calendars.(key).errors[] list שגיאות אופציונליות (אם החישוב של היומן נכשל).
calendars.(key).errors[].domain string הדומיין או הקטגוריה הכללית של השגיאה.
calendars.(key).errors[].reason string הסיבה הספציפית לשגיאה. אלה כמה מהערכים האפשריים:
  • 'groupTooBig' – קבוצת המשתמשים המבוקשת גדולה מדי לשאילתה אחת.
  • 'tooManyCalendarsRequested' – מספר היומנים המבוקשים גדול מדי לשאילתה אחת.
  • 'notFound' – המשאב המבוקש לא נמצא.
  • 'internalError' – שירות ה-API נתקל בשגיאה פנימית.
יכול להיות שסוגי שגיאות נוספים יתווספו בעתיד, לכן הלקוחות צריכים לטפל בצורה תקינה בסטטוסים נוספים של שגיאות שלא נכללים ברשימה הזו.
calendars.(key).busy[] list רשימת טווחי הזמן שבהם יומן זה ייחשב כעמוס.
calendars.(key).busy[].start datetime תחילת תקופת הזמן (כולל).
calendars.(key).busy[].end datetime סיום תקופת הזמן (לא כולל).

נסה בעצמך!

אפשר להשתמש ב-API Explorer שבהמשך כדי להפעיל את השיטה הזו על נתונים פעילים ולראות את התגובה.