CalendarList

उपयोगकर्ता की कैलेंडर सूची में शामिल कैलेंडर. Calendars vs CalendarListके बारे में भी पढ़ें.

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

संसाधन के बारे में जानकारी

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": 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
    ]
  },
  "autoAcceptInvitations": boolean
}
प्रॉपर्टी का नाम मान ब्यौरा नोट
accessRole string इससे पता चलता है कि पुष्टि किए गए उपयोगकर्ता के पास, कैलेंडर का कौनसी भूमिका वाला ऐक्सेस है. सिर्फ़ पढ़ने का ऐक्सेस. इन वैल्यू का इस्तेमाल किया जा सकता है:
  • "freeBusyReader" - इससे, खाली/बिज़ी होने की जानकारी को पढ़ने का ऐक्सेस मिलता है.
  • "reader" - इससे, कैलेंडर को पढ़ने का ऐक्सेस मिलता है. रीडर ऐक्सेस वाले उपयोगकर्ताओं को निजी इवेंट दिखेंगे, लेकिन इवेंट की जानकारी छिपी रहेगी.
  • "writerWithoutPrivateAccess" - इससे, कैलेंडर को पढ़ने और उसमें बदलाव करने का ऐक्सेस मिलता है. writerWithoutPrivateAccess ऐक्सेस वाले उपयोगकर्ताओं को निजी इवेंट दिखेंगे, लेकिन इवेंट की जानकारी छिपी रहेगी.
  • "writer" - इससे, कैलेंडर को पढ़ने और उसमें बदलाव करने का ऐक्सेस मिलता है. राइटर ऐक्सेस वाले उपयोगकर्ताओं को निजी इवेंट दिखेंगे. साथ ही, वे इवेंट की जानकारी भी देख पाएंगे.
  • "owner" - इससे, कैलेंडर को मैनेज करने का ऐक्सेस मिलता है. इस भूमिका में, राइटर की भूमिका वाली सभी अनुमतियां होती हैं. इसके अलावा, अन्य उपयोगकर्ताओं के ऐक्सेस लेवल को देखने और उनमें बदलाव करने की अनुमति भी होती है.

autoAcceptInvitations boolean इससे पता चलता है कि यह कैलेंडर, न्योते अपने-आप स्वीकार करता है या नहीं. यह सुविधा सिर्फ़ संसाधन वाले कैलेंडर के लिए मान्य है. सिर्फ़ पढ़ने का ऐक्सेस.
backgroundColor string यह कैलेंडर का मुख्य रंग है, जो हेक्साडेसिमल फ़ॉर्मैट "#0088aa" में होता है. यह प्रॉपर्टी, इंडेक्स पर आधारित colorId प्रॉपर्टी की जगह इस्तेमाल की जाती है. इस प्रॉपर्टी को सेट या बदलने के लिए, आपको colorRgbFormat=true को insert, update और patch तरीकों के पैरामीटर में तय करना होगा. ज़रूरी नहीं. लिखने की अनुमति
colorId string यह कैलेंडर का रंग है. यह एक आईडी है, जो रंगों की परिभाषा के calendar सेक्शन में मौजूद किसी एंट्री को दिखाता है. इसके बारे में जानने के लिए, रंगों का एंडपॉइंट देखें. यह प्रॉपर्टी, backgroundColor और foregroundColor प्रॉपर्टी की जगह इस्तेमाल की जाती है. इन प्रॉपर्टी का इस्तेमाल करते समय, इसे अनदेखा किया जा सकता है. ज़रूरी नहीं. लिखने की अनुमति
conferenceProperties nested object यह इस कैलेंडर के लिए कॉन्फ़्रेंसिंग प्रॉपर्टी है. जैसे, किस तरह की कॉन्फ़्रेंस की अनुमति है.
conferenceProperties.allowedConferenceSolutionTypes[] list इससे पता चलता है कि इस कैलेंडर के लिए, किस तरह के कॉन्फ़्रेंस सलूशन इस्तेमाल किए जा सकते हैं.

इन वैल्यू का इस्तेमाल किया जा सकता है:

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

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

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

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

 लिखने की अनुमति
deleted boolean इससे पता चलता है कि कैलेंडर सूची से, इस कैलेंडर सूची की एंट्री को मिटाया गया है या नहीं. सिर्फ़ पढ़ने का ऐक्सेस. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, इसकी वैल्यू 'गलत' होती है.
description string यह कैलेंडर की जानकारी है. ज़रूरी नहीं. सिर्फ़ पढ़ने का ऐक्सेस.
etag etag यह संसाधन का ETag है.
foregroundColor string यह कैलेंडर का फ़ोरग्राउंड कलर है, जो हेक्साडेसिमल फ़ॉर्मैट "#ffffff" में होता है. यह प्रॉपर्टी, इंडेक्स पर आधारित colorId प्रॉपर्टी की जगह इस्तेमाल की जाती है. इस प्रॉपर्टी को सेट या बदलने के लिए, आपको colorRgbFormat=true को insert, update और patch तरीकों के पैरामीटर में तय करना होगा. ज़रूरी नहीं. लिखने की अनुमति
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 यह कैलेंडर का टाइम ज़ोन है. ज़रूरी नहीं. सिर्फ़ पढ़ने का ऐक्सेस.

तरीके

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