उपयोगकर्ता के कैलेंडर की सूची में कोई मौजूदा कैलेंडर जोड़ता है. इसे अभी आज़माएं.
अनुरोध
एचटीटीपी अनुरोध
POST https://www.googleapis.com/calendar/v3/users/me/calendarList
पैरामीटर
पैरामीटर का नाम | मान | ब्यौरा |
---|---|---|
ज़रूरी नहीं क्वेरी पैरामीटर | ||
colorRgbFormat |
boolean |
कैलेंडर के रंग (आरजीबी) लिखने के लिए, foregroundColor और backgroundColor फ़ील्ड का इस्तेमाल करना है या नहीं. इस सुविधा का इस्तेमाल करने पर, इंडेक्स पर आधारित colorId फ़ील्ड अपने-आप सबसे अच्छी तरह से मैच होने वाले विकल्प पर सेट हो जाएगा. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह 'गलत' पर सेट होता है.
|
अनुमति देना
इस अनुरोध के लिए, इनमें से कम से कम एक स्कोप के साथ अनुमति लेना ज़रूरी है:
दायरा |
---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.calendarlist |
ज़्यादा जानकारी के लिए, पुष्टि और अनुमति पेज देखें.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में, इन प्रॉपर्टी के साथ CalendarList रिसॉर्स दें:
प्रॉपर्टी का नाम | मान | ब्यौरा | नोट |
---|---|---|---|
ज़रूरी प्रॉपर्टी | |||
id |
string |
कैलेंडर का आइडेंटिफ़ायर. | |
ज़रूरी नहीं प्रॉपर्टी | |||
backgroundColor |
string |
हेक्साडेसिमल फ़ॉर्मैट "#0088aa " में कैलेंडर का मुख्य रंग. यह प्रॉपर्टी, इंडेक्स पर आधारित colorId प्रॉपर्टी की जगह लेती है. इस प्रॉपर्टी को सेट करने या बदलने के लिए, आपको insert, update, और patch तरीकों के पैरामीटर में colorRgbFormat=true की वैल्यू देनी होगी. ज़रूरी नहीं. |
लिखा जा सकता है |
colorId |
string |
कैलेंडर का रंग. यह एक आईडी है, जो कलर की परिभाषा के calendar सेक्शन में मौजूद किसी एंट्री का रेफ़रंस देता है. कलर एंडपॉइंट देखें. इस प्रॉपर्टी की जगह backgroundColor और foregroundColor प्रॉपर्टी का इस्तेमाल किया जाता है. साथ ही, इन प्रॉपर्टी का इस्तेमाल करते समय, इस प्रॉपर्टी को अनदेखा किया जा सकता है. ज़रूरी नहीं. |
लिखा जा सकता है |
defaultReminders[] |
list |
इस कैलेंडर के लिए, पुष्टि किए गए उपयोगकर्ता के डिफ़ॉल्ट रिमाइंडर. | लिखा जा सकता है |
defaultReminders[].method |
string |
इस रिमाइंडर के लिए इस्तेमाल किया गया तरीका. वैल्यू इस तरह की हो सकती हैं:
रिमाइंडर जोड़ते समय ज़रूरी है. |
लिखा जा सकता है |
defaultReminders[].minutes |
integer |
इवेंट शुरू होने से कितने मिनट पहले रिमाइंडर ट्रिगर होना चाहिए. वैल्यू 0 से 40320 (मिनट में चार हफ़्ते) के बीच होनी चाहिए. रिमाइंडर जोड़ते समय ज़रूरी है. |
लिखा जा सकता है |
foregroundColor |
string |
हेक्साडेसिमल फ़ॉर्मैट "#ffffff " में, कैलेंडर के फ़ोरग्राउंड का रंग. यह प्रॉपर्टी, इंडेक्स पर आधारित colorId प्रॉपर्टी की जगह लेती है. इस प्रॉपर्टी को सेट करने या बदलने के लिए, आपको insert, update, और patch तरीकों के पैरामीटर में colorRgbFormat=true की वैल्यू देनी होगी. ज़रूरी नहीं. |
लिखा जा सकता है |
notificationSettings |
object |
इस कैलेंडर के लिए, पुष्टि किए गए उपयोगकर्ता को मिलने वाली सूचनाएं. | लिखा जा सकता है |
notificationSettings.notifications[].method |
string |
सूचना भेजने के लिए इस्तेमाल किया गया तरीका. इसकी वैल्यू इस तरह की हो सकती है:
सूचना जोड़ते समय ज़रूरी है. |
लिखा जा सकता है |
notificationSettings.notifications[].type |
string |
सूचना का टाइप. वैल्यू इस तरह की हो सकती हैं:
सूचना जोड़ते समय ज़रूरी है. |
लिखा जा सकता है |
selected |
boolean |
कैलेंडर का कॉन्टेंट, कैलेंडर के यूज़र इंटरफ़ेस (यूआई) में दिखेगा या नहीं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह 'गलत' पर सेट होता है. | लिखा जा सकता है |
summaryOverride |
string |
पुष्टि किए गए उपयोगकर्ता ने इस कैलेंडर के लिए जो खास जानकारी सेट की है. ज़रूरी नहीं. | लिखा जा सकता है |
जवाब
अगर यह तरीका कामयाब होता है, तो जवाब के मुख्य हिस्से में CalendarList रिसॉर्स दिखता है.
इसे आज़माएं!
लाइव डेटा पर इस तरीके को कॉल करने और रिस्पॉन्स देखने के लिए, नीचे दिए गए एपीआई एक्सप्लोरर का इस्तेमाल करें.