API Reference

इस एपीआई रेफ़रंस को संसाधन के टाइप के हिसाब से व्यवस्थित किया गया है. हर संसाधन टाइप में, डेटा के एक या उससे ज़्यादा प्रज़ेंटेशन और एक या उससे ज़्यादा तरीके होते हैं.

संसाधन के टाइप

  1. Acl
  2. CalendarList
  3. कैलेंडर
  4. चैनल
  5. रंग
  6. इवेंट
  7. Freebusy
  8. सेटिंग

Acl

एसीएल संसाधन की जानकारी के लिए, संसाधन का प्रतिनिधित्व पेज देखें.

तरीका एचटीटीपी अनुरोध ब्यौरा
जब तक अलग से बताया न जाए, तब तक यही मानें कि सभी यूआरआई https://www.googleapis.com/calendar/v3 से जुड़े हुए हैं
मिटाएं DELETE  /calendars/calendarId/acl/ruleId ऐक्सेस कंट्रोल का नियम मिटाता है.
पाएं GET  /calendars/calendarId/acl/ruleId यह फ़ंक्शन, ऐक्सेस कंट्रोल का नियम दिखाता है.
insert POST  /calendars/calendarId/acl ऐक्सेस कंट्रोल का नियम बनाता है.
list GET  /calendars/calendarId/acl यह फ़ंक्शन, कैलेंडर के लिए ऐक्सेस कंट्रोल लिस्ट में मौजूद नियमों को दिखाता है.
पैच PATCH  /calendars/calendarId/acl/ruleId यह ऐक्सेस कंट्रोल के नियम को अपडेट करता है. यह तरीका, पैच सिमैंटिक के साथ काम करता है. ध्यान दें कि हर पैच अनुरोध में तीन कोटा यूनिट इस्तेमाल होती हैं. इसलिए, get के बाद update का इस्तेमाल करना बेहतर होता है. आपके दिए गए फ़ील्ड की वैल्यू, मौजूदा वैल्यू की जगह ले लेती हैं. अनुरोध में जिन फ़ील्ड के बारे में नहीं बताया जाता है उनमें कोई बदलाव नहीं होता. अगर ऐरे फ़ील्ड तय किए जाते हैं, तो वे मौजूदा ऐरे को बदल देते हैं. इससे, ऐरे के पिछले सभी एलिमेंट हट जाते हैं.
अपडेट करें PUT  /calendars/calendarId/acl/ruleId यह ऐक्सेस कंट्रोल के नियम को अपडेट करता है.
watch POST  /calendars/calendarId/acl/watch एसीएल संसाधनों में हुए बदलावों को ट्रैक करें.

CalendarList

CalendarList रिसॉर्स की जानकारी के लिए, resource representation पेज देखें.

तरीका एचटीटीपी अनुरोध ब्यौरा
जब तक अलग से बताया न जाए, तब तक यही मानें कि सभी यूआरआई https://www.googleapis.com/calendar/v3 से जुड़े हुए हैं
मिटाएं DELETE  /users/me/calendarList/calendarId यह उपयोगकर्ता की कैलेंडर सूची से किसी कैलेंडर को हटाता है.
पाएं GET  /users/me/calendarList/calendarId इससे उपयोगकर्ता की कैलेंडर सूची से कोई कैलेंडर मिलता है.
insert POST  /users/me/calendarList इसकी मदद से, किसी मौजूदा कैलेंडर को उपयोगकर्ता की कैलेंडर सूची में जोड़ा जाता है.
list GET  /users/me/calendarList इससे उपयोगकर्ता की कैलेंडर सूची में मौजूद कैलेंडर दिखते हैं.
पैच PATCH  /users/me/calendarList/calendarId उपयोगकर्ता की कैलेंडर सूची में मौजूद किसी कैलेंडर को अपडेट करता है. यह तरीका, पैच सिमैंटिक के साथ काम करता है. ध्यान दें कि हर पैच अनुरोध में तीन कोटा यूनिट इस्तेमाल होती हैं. इसलिए, get के बाद update का इस्तेमाल करना बेहतर होता है. आपके दिए गए फ़ील्ड की वैल्यू, मौजूदा वैल्यू की जगह ले लेती हैं. अनुरोध में जिन फ़ील्ड के बारे में नहीं बताया जाता है उनमें कोई बदलाव नहीं होता. अगर ऐरे फ़ील्ड तय किए जाते हैं, तो वे मौजूदा ऐरे को बदल देते हैं. इससे, ऐरे के पिछले सभी एलिमेंट हट जाते हैं.
अपडेट करें PUT  /users/me/calendarList/calendarId उपयोगकर्ता की कैलेंडर सूची में मौजूद किसी कैलेंडर को अपडेट करता है.
watch POST  /users/me/calendarList/watch CalendarList संसाधनों में हुए बदलावों पर नज़र रखें.

कैलेंडर

कैलेंडर संसाधन की जानकारी के लिए, संसाधन का प्रतिनिधित्व पेज देखें.

तरीका एचटीटीपी अनुरोध ब्यौरा
जब तक अलग से बताया न जाए, तब तक यही मानें कि सभी यूआरआई https://www.googleapis.com/calendar/v3 से जुड़े हुए हैं
हटाएं POST  /calendars/calendarId/clear मुख्य कैलेंडर को मिटाता है. इस ऑपरेशन से, किसी खाते के मुख्य कैलेंडर से जुड़े सभी इवेंट मिट जाते हैं.
मिटाएं DELETE  /calendars/calendarId इस तरीके का इस्तेमाल करके, सेकंडरी कैलेंडर मिटाया जा सकता है. मुख्य कैलेंडर के सभी इवेंट मिटाने के लिए, calendars.clear का इस्तेमाल करें.
पाएं GET  /calendars/calendarId यह फ़ंक्शन, किसी कैलेंडर के लिए मेटाडेटा दिखाता है.
insert POST  /calendars सेकंडरी कैलेंडर बनाता है.

अनुरोध करने वाले पुष्टि किए गए उपयोगकर्ता को नए कैलेंडर का डेटा मालिक बना दिया जाता है.

पैच PATCH  /calendars/calendarId यह कैलेंडर के मेटाडेटा को अपडेट करता है. यह तरीका, पैच सिमैंटिक के साथ काम करता है. ध्यान दें कि हर पैच अनुरोध में तीन कोटा यूनिट इस्तेमाल होती हैं. इसलिए, get के बाद update का इस्तेमाल करना बेहतर होता है. आपके दिए गए फ़ील्ड की वैल्यू, मौजूदा वैल्यू की जगह ले लेती हैं. अनुरोध में जिन फ़ील्ड के बारे में नहीं बताया जाता है उनमें कोई बदलाव नहीं होता. अगर ऐरे फ़ील्ड तय किए जाते हैं, तो वे मौजूदा ऐरे को बदल देते हैं. इससे, ऐरे के पिछले सभी एलिमेंट हट जाते हैं.
transferOwnership POST  /calendars/calendarId/transferOwnership यह फ़ंक्शन, Google Workspace संगठन के उपयोगकर्ताओं के बीच सेकंडरी कैलेंडर ट्रांसफ़र करता है. इसके लिए, उपयोगकर्ता की पुष्टि करना ज़रूरी है. साथ ही, उसके पास कैलेंडर मैनेज करने से जुड़ा एडमिन का अधिकार होना चाहिए. इसके अलावा, उसके पास अनुमति के ये स्कोप होने चाहिए:
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars
अनुरोध में, useAdminAccess को true पर सेट करें. ट्रांसफ़र करने के लिए, सेकंडरी कैलेंडर चालू होना चाहिए. बंद किए गए या मिटाए गए कैलेंडर ट्रांसफ़र नहीं किए जा सकते.

ज़रूरी क्वेरी पैरामीटर: newDataOwner, useAdminAccess

अपडेट करें PUT  /calendars/calendarId यह कैलेंडर के मेटाडेटा को अपडेट करता है.

चैनल

चैनल के संसाधन की जानकारी के लिए, संसाधन का प्रतिनिधित्व पेज देखें.

तरीका एचटीटीपी अनुरोध ब्यौरा
जब तक अलग से बताया न जाए, तब तक यही मानें कि सभी यूआरआई https://www.googleapis.com/calendar/v3 से जुड़े हुए हैं
बंद करें POST  /channels/stop इस चैनल के ज़रिए संसाधन देखना बंद करें.

रंग

कलर रिसॉर्स की जानकारी के लिए, संसाधन का प्रतिनिधित्व पेज देखें.

तरीका एचटीटीपी अनुरोध ब्यौरा
जब तक अलग से बताया न जाए, तब तक यही मानें कि सभी यूआरआई https://www.googleapis.com/calendar/v3 से जुड़े हुए हैं
पाएं GET  /colors यह फ़ंक्शन, कैलेंडर और इवेंट के लिए रंग की परिभाषाएं दिखाता है.

इवेंट

इवेंट के संसाधन की जानकारी के लिए, संसाधन का प्रतिनिधित्व पेज देखें.

तरीका एचटीटीपी अनुरोध ब्यौरा
जब तक अलग से बताया न जाए, तब तक यही मानें कि सभी यूआरआई https://www.googleapis.com/calendar/v3 से जुड़े हुए हैं
मिटाएं DELETE  /calendars/calendarId/events/eventId इस कुकी का इस्तेमाल किसी इवेंट को मिटाने के लिए किया जाता है.
पाएं GET  /calendars/calendarId/events/eventId यह फ़ंक्शन, Google Calendar आईडी के आधार पर इवेंट दिखाता है. किसी इवेंट को उसके iCalendar आईडी का इस्तेमाल करके वापस पाने के लिए, events.list तरीके को iCalUID पैरामीटर का इस्तेमाल करके कॉल करें.
import POST  /calendars/calendarId/events/import यह कुकी, किसी इवेंट को इंपोर्ट करती है. इस ऑपरेशन का इस्तेमाल, किसी कैलेंडर में मौजूदा इवेंट की निजी कॉपी जोड़ने के लिए किया जाता है. सिर्फ़ default के eventType वाले इवेंट इंपोर्ट किए जा सकते हैं.

अब काम नहीं करता: अगर कोई ऐसा इवेंट इंपोर्ट किया जाता है जो default नहीं है, तो उसका टाइप default में बदल जाएगा. साथ ही, इवेंट टाइप के हिसाब से उसकी प्रॉपर्टी हटा दी जाएंगी.

insert POST  /calendars/calendarId/events इस कुकी का इस्तेमाल इवेंट बनाने के लिए किया जाता है.
instances GET  /calendars/calendarId/events/eventId/instances बार-बार होने वाले इवेंट के इंस्टेंस दिखाता है.
list GET  /calendars/calendarId/events यह फ़ंक्शन, बताए गए कैलेंडर में मौजूद इवेंट दिखाता है.
move POST  /calendars/calendarId/events/eventId/move इस कार्रवाई से, इवेंट को किसी दूसरे कैलेंडर में ले जाया जाता है. इसका मतलब है कि इवेंट का आयोजक बदल जाता है. ध्यान दें कि सिर्फ़ default इवेंट को ट्रांसफ़र किया जा सकता है. birthday, focusTime, fromGmail, outOfOffice, और workingLocation इवेंट को ट्रांसफ़र नहीं किया जा सकता.

ज़रूरी क्वेरी पैरामीटर: destination

पैच PATCH  /calendars/calendarId/events/eventId इस कुकी का इस्तेमाल किसी इवेंट को अपडेट करने के लिए किया जाता है. यह तरीका, पैच सिमैंटिक के साथ काम करता है. ध्यान दें कि हर पैच अनुरोध में तीन कोटा यूनिट इस्तेमाल होती हैं. इसलिए, get के बाद update का इस्तेमाल करना बेहतर होता है. आपके दिए गए फ़ील्ड की वैल्यू, मौजूदा वैल्यू की जगह ले लेती हैं. अनुरोध में जिन फ़ील्ड के बारे में नहीं बताया जाता है उनमें कोई बदलाव नहीं होता. अगर ऐरे फ़ील्ड तय किए जाते हैं, तो वे मौजूदा ऐरे को बदल देते हैं. इससे, ऐरे के पिछले सभी एलिमेंट हट जाते हैं.
quickAdd POST  /calendars/calendarId/events/quickAdd यह कुकी, सामान्य टेक्स्ट स्ट्रिंग के आधार पर इवेंट बनाती है.

ज़रूरी क्वेरी पैरामीटर: text

अपडेट करें PUT  /calendars/calendarId/events/eventId इस कुकी का इस्तेमाल किसी इवेंट को अपडेट करने के लिए किया जाता है. यह तरीका, पैच सिमैंटिक्स के साथ काम नहीं करता. साथ ही, यह हमेशा पूरे इवेंट रिसॉर्स को अपडेट करता है. आंशिक अपडेट करने के लिए, एटैग का इस्तेमाल करके get और फिर update करें, ताकि यह पक्का किया जा सके कि अपडेट एक साथ हो.
watch POST  /calendars/calendarId/events/watch इवेंट रिसॉर्स में होने वाले बदलावों को ट्रैक करें.

खाली/व्यस्त

उपलब्धता की जानकारी देने वाले संसाधन के बारे में जानने के लिए, संसाधन का प्रतिनिधित्व पेज देखें.

तरीका एचटीटीपी अनुरोध ब्यौरा
जब तक अलग से बताया न जाए, तब तक यही मानें कि सभी यूआरआई https://www.googleapis.com/calendar/v3 से जुड़े हुए हैं
query POST  /freeBusy यह फ़ंक्शन, कैलेंडर के किसी सेट के लिए खाली/व्यस्त होने की जानकारी दिखाता है.

सेटिंग

सेटिंग रिसॉर्स के बारे में ज़्यादा जानने के लिए, रिसॉर्स का रेफ़रंस पेज देखें.

तरीका एचटीटीपी अनुरोध ब्यौरा
जब तक अलग से बताया न जाए, तब तक यही मानें कि सभी यूआरआई https://www.googleapis.com/calendar/v3 से जुड़े हुए हैं
पाएं GET  /users/me/settings/setting यह किसी उपयोगकर्ता की एक सेटिंग दिखाता है.
list GET  /users/me/settings यह पुष्टि किए गए उपयोगकर्ता के लिए, उपयोगकर्ता की सभी सेटिंग दिखाता है.
watch POST  /users/me/settings/watch सेटिंग के संसाधनों में हुए बदलावों पर नज़र रखें.