Freebusy: query

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

अनुरोध

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

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 जवाब में इस्तेमाल किया गया टाइम ज़ोन. ज़रूरी नहीं. डिफ़ॉल्ट यूटीसी होता है.
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" - एपीआई सेवा में कोई अंदरूनी गड़बड़ी हुई है.
आने वाले समय में, गड़बड़ी के दूसरे टाइप भी जोड़े जा सकते हैं. इसलिए, क्लाइंट को गड़बड़ी की उन दूसरी स्थितियों को अच्छे से मैनेज करना चाहिए जो इस सूची में शामिल नहीं हैं.
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 समयावधि के खत्म होने का खास समय.

इसे आज़माएं!

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