Freebusy: query

कैलेंडर के किसी सेट के लिए, खाली/व्यस्त जानकारी दिखाता है. इसे अभी आज़माएं.

अनुरोध

एचटीटीपी अनुरोध

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 जवाब में इस्तेमाल किया गया टाइम ज़ोन. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यूटीसी का इस्तेमाल किया जाता है.
groupExpansionMax integer किसी एक ग्रुप के लिए, ज़्यादा से ज़्यादा कैलेंडर आइडेंटिफ़ायर दिए जा सकते हैं. ज़रूरी नहीं. अगर किसी ग्रुप में इस वैल्यू से ज़्यादा सदस्य हैं, तो गड़बड़ी का मैसेज दिखता है. ज़्यादा से ज़्यादा वैल्यू 100 हो सकती है.
calendarExpansionMax integer उन कैलेंडर की ज़्यादा से ज़्यादा संख्या जिनके लिए खाली/व्यस्त जानकारी देनी है. ज़रूरी नहीं. ज़्यादा से ज़्यादा वैल्यू 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" - एपीआई सेवा में कोई अंदरूनी गड़बड़ी हुई है.
आने वाले समय में, गड़बड़ी के अन्य टाइप जोड़े जा सकते हैं. इसलिए, क्लाइंट को इस सूची में शामिल नहीं की गई गड़बड़ी की अन्य स्थितियों को आसानी से मैनेज करना चाहिए.
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" - एपीआई सेवा में कोई अंदरूनी गड़बड़ी हुई है.
आने वाले समय में, गड़बड़ी के अन्य टाइप जोड़े जा सकते हैं. इसलिए, क्लाइंट को इस सूची में शामिल नहीं की गई गड़बड़ी की अन्य स्थितियों को आसानी से मैनेज करना चाहिए.
calendars.(key).busy[] list उन समयावधि की सूची जिनमें इस कैलेंडर को व्यस्त माना जाना चाहिए.
calendars.(key).busy[].start datetime समयावधि की शुरुआत.
calendars.(key).busy[].end datetime समयावधि खत्म होने का समय (अलग से उपलब्ध).

इसे आज़माएं!

लाइव डेटा पर इस तरीके को कॉल करने और रिस्पॉन्स देखने के लिए, नीचे दिए गए एपीआई एक्सप्लोरर का इस्तेमाल करें.