API Reference

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

रिसॉर्स टाइप

  1. Acl
  2. CalendarList
  3. कैलेंडर
  4. चैनल
  5. रंग
  6. इवेंट
  7. खाली/व्यस्त
  8. सेटिंग

Acl

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

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

CalendarList

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

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

कैलेंडर छापने की सेवा

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

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

चैनल

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

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

कलर

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

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

इवेंट

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

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

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

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

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

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

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

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

खाली/व्यस्त

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

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

सेटिंग

संसाधन की सेटिंग से जुड़ी जानकारी के लिए, संसाधन दिखाना पेज देखें.

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