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	समयावधि का (खास तौर पर) खत्म होने वाला समय.

इसे आज़माएं!

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