דף זה תורגם על ידי Cloud Translation API.

Freebusy: query

הצגת פרטי פנוי/עסוק של קבוצת יומנים. רוצים לנסות עכשיו?

בקשה

בקשת 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
    }
  ]
}

שם הנכס	ערך	תיאור
`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
        }
      ]
    }
  }
}

שם הנכס	ערך	תיאור
`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`	סוף תקופת הזמן (לא כולל).

נסה בעצמך!

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