CalendarList

उपयोगकर्ता की कैलेंडर सूची में मौजूद कैलेंडर का कलेक्शन. Calendar बनाम CalendarList.

इस संसाधन के तरीकों की सूची के लिए, इस पेज का अंत देखें.

संसाधनों का प्रतिनिधित्व

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "summaryOverride": string,
  "colorId": string,
  "backgroundColor": string,
  "foregroundColor": string,
  "hidden": boolean,
  "selected": boolean,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": string,
        "method": string
      }
    ]
  },
  "primary": boolean,
  "deleted": boolean,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  }
}
प्रॉपर्टी का नाम वैल्यू ब्यौरा ज़रूरी जानकारी
accessRole string कैलेंडर पर पुष्टि किए गए उपयोगकर्ता की असरदार ऐक्सेस भूमिका. सिर्फ़ पढ़ने के लिए. आपको ये वैल्यू दिख सकती हैं:
  • "freeBusyReader" - खाली/व्यस्त जानकारी को पढ़ने का ऐक्सेस देता है.
  • "reader" - कैलेंडर को पढ़ने का ऐक्सेस देता है. जिन लोगों के पास पाठक का ऐक्सेस है उन्हें निजी इवेंट दिखेंगे. हालांकि, इवेंट की जानकारी नहीं दिखेगी.
  • "writer" - कैलेंडर में पढ़ने और लिखने का ऐक्सेस देता है. निजी इवेंट उन लोगों को दिखेंगे जिनके पास लेखक का ऐक्सेस है. साथ ही, इवेंट की जानकारी भी दिखेगी.
  • "owner" - कैलेंडर का मालिकाना हक देता है. इस भूमिका में लेखक की भूमिका वाली सभी अनुमतियां होती हैं. साथ ही, उसके पास ACL देखने और उनमें बदलाव करने की अतिरिक्त सुविधा होती है.
backgroundColor string कैलेंडर का मुख्य रंग हेक्साडेसिमल फ़ॉर्मैट "#0088aa" में है. यह प्रॉपर्टी, इंडेक्स-आधारित colorId प्रॉपर्टी की जगह लेगी. इस प्रॉपर्टी को सेट करने या बदलने के लिए, आपको insert, अपडेट, और पैच तरीके के पैरामीटर में, colorRgbFormat=true के बारे में बताना होगा. ज़रूरी नहीं. लिखने योग्य
colorId string कैलेंडर का रंग. यह एक आईडी है जो कलर की परिभाषा के calendar सेक्शन में मौजूद एंट्री के बारे में बताता है. इसके लिए, कलर एंडपॉइंट देखें. इस प्रॉपर्टी को backgroundColor और foregroundColor प्रॉपर्टी ने बदल दिया है और इन प्रॉपर्टी का इस्तेमाल करते समय इन्हें अनदेखा किया जा सकता है. ज़रूरी नहीं. लिखने योग्य
conferenceProperties nested object इस कैलेंडर के लिए कॉन्फ़्रेंसिंग की प्रॉपर्टी. उदाहरण के लिए, किस तरह की कॉन्फ़्रेंस की अनुमति है.
conferenceProperties.allowedConferenceSolutionTypes[] list इस कैलेंडर में काम करने वाले कॉन्फ़्रेंस के समाधान के टाइप.

आपको ये वैल्यू दिख सकती हैं:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
ज़रूरी नहीं.

defaultReminders[] list इस कैलेंडर के लिए वे डिफ़ॉल्ट रिमाइंडर जो पुष्टि किए गए उपयोगकर्ता के पास हैं. लिखने योग्य
defaultReminders[].method string इस रिमाइंडर में इस्तेमाल किया गया तरीका. आपको ये वैल्यू दिख सकती हैं:
  • "email" - रिमाइंडर, ईमेल से भेजे जाते हैं.
  • "popup" - रिमाइंडर, यूज़र इंटरफ़ेस (यूआई) पॉप-अप के ज़रिए भेजे जाते हैं.

रिमाइंडर जोड़ते समय ज़रूरी है.

लिखने योग्य
defaultReminders[].minutes integer रिमाइंडर ट्रिगर होने के बाद, इवेंट शुरू होने के कितने मिनट पहले ट्रिगर होना चाहिए. मान्य वैल्यू 0 से 40320 के बीच होती हैं (मिनट में चार हफ़्ते).

रिमाइंडर जोड़ते समय ज़रूरी है.

लिखने योग्य
deleted boolean क्या कैलेंडर सूची की यह एंट्री, कैलेंडर की सूची से मिटा दी गई है. सिर्फ़ पढ़ने के लिए. ज़रूरी नहीं. डिफ़ॉल्ट रूप से यह वैल्यू 'गलत' पर सेट होती है.
description string कैलेंडर का ब्यौरा. ज़रूरी नहीं. सिर्फ़ पढ़ने के लिए.
etag etag संसाधन का ईटैग.
foregroundColor string कैलेंडर का हेक्साडेसिमल फ़ॉर्मैट "#ffffff" में फ़ोरग्राउंड रंग. यह प्रॉपर्टी, इंडेक्स-आधारित colorId प्रॉपर्टी की जगह ले लेगी. इस प्रॉपर्टी को सेट करने या बदलने के लिए, आपको insert, अपडेट, और पैच तरीके के पैरामीटर में, colorRgbFormat=true के बारे में बताना होगा. ज़रूरी नहीं. लिखने योग्य
hidden boolean कैलेंडर को सूची से छिपाया गया है या नहीं. ज़रूरी नहीं. यह एट्रिब्यूट सिर्फ़ तब दिखता है, जब कैलेंडर छिपा होता है. इस स्थिति में, वैल्यू true होती है. लिखने योग्य
id string कैलेंडर का आइडेंटिफ़ायर.
kind string संसाधन का टाइप ("calendar#calendarListEntry").
location string फ़्री फ़ॉर्म टेक्स्ट के तौर पर कैलेंडर की भौगोलिक जगह. ज़रूरी नहीं. सिर्फ़ पढ़ने के लिए.
notificationSettings object वे सूचनाएं जो प्रमाणित उपयोगकर्ता को इस कैलेंडर के लिए मिल रही हैं. लिखने योग्य
notificationSettings.notifications[] list इस कैलेंडर के लिए सेट की गई सूचनाओं की सूची.
notificationSettings.notifications[].method string सूचना भेजने के लिए इस्तेमाल किया गया तरीका. संभावित वैल्यू है:
  • "email" - सूचनाएं ईमेल से भेजी जाती हैं.

सूचना जोड़ते समय ज़रूरी है.

लिखने योग्य
notificationSettings.notifications[].type string सूचना किस तरह की है. आपको ये वैल्यू दिख सकती हैं:
  • "eventCreation" - कैलेंडर में कोई नया इवेंट जोड़े जाने पर सूचना भेजी जाती है.
  • "eventChange" - किसी इवेंट में बदलाव होने पर सूचना भेजी जाती है.
  • "eventCancellation" - किसी इवेंट के रद्द होने पर सूचना भेजी जाती है.
  • "eventResponse" - जब कोई मेहमान इवेंट के न्योते का जवाब देता है, तब सूचना भेजी जाती है.
  • "agenda" - दिन के इवेंट वाला एजेंडा (सुबह में भेजा जाता है).

सूचना जोड़ते समय ज़रूरी है.

लिखने योग्य
primary boolean कैलेंडर, पुष्टि किए गए उपयोगकर्ता का मुख्य कैलेंडर है. सिर्फ़ पढ़ने के लिए. ज़रूरी नहीं. डिफ़ॉल्ट रूप से यह वैल्यू 'गलत' पर सेट होती है.
selected boolean कैलेंडर का कॉन्टेंट, कैलेंडर के यूज़र इंटरफ़ेस (यूआई) में दिखता है या नहीं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से यह वैल्यू 'गलत' पर सेट होती है. लिखने योग्य
summary string कैलेंडर का टाइटल. सिर्फ़ पढ़ने के लिए.
summaryOverride string वह खास जानकारी जिसे पुष्टि किए गए उपयोगकर्ता ने इस कैलेंडर के लिए सेट किया है. ज़रूरी नहीं. लिखने योग्य
timeZone string कैलेंडर का टाइम ज़ोन. ज़रूरी नहीं. सिर्फ़ पढ़ने के लिए.

तरीके

मिटाएं
उपयोगकर्ता की कैलेंडर सूची से कैलेंडर को हटाता है.
पाएं
उपयोगकर्ता की कैलेंडर सूची से कैलेंडर दिखाता है.
शामिल करें
मौजूदा कैलेंडर को उपयोगकर्ता की कैलेंडर सूची में जोड़ता है.
list
उपयोगकर्ता की कैलेंडर सूची में कैलेंडर दिखाता है.
पैच
उपयोगकर्ता की कैलेंडर सूची पर मौजूदा कैलेंडर को अपडेट करता है. यह विधि पैच सिमैंटिक का समर्थन करती है. ध्यान दें कि हर पैच के लिए अनुरोध करने पर, तीन कोटा यूनिट का इस्तेमाल होता है. ज़्यादा से ज़्यादा get के बाद update का इस्तेमाल किया जाता है. आपकी तय की गई फ़ील्ड वैल्यू, मौजूदा वैल्यू को बदल देती हैं. आपने जो फ़ील्ड अनुरोध में नहीं दिए हैं उनमें कोई बदलाव नहीं होगा. अरे फ़ील्ड बताए जाने पर, मौजूदा अरे को ओवरराइट कर देते हैं. ऐसा करने पर, पहले से मौजूद अरे एलिमेंट खारिज हो जाते हैं.
अपडेट करें
उपयोगकर्ता की कैलेंडर सूची पर मौजूदा कैलेंडर को अपडेट करता है.
देखें
CalendarList संसाधनों में हुए बदलावों को देखें.