CalendarList

उपयोगकर्ता की कैलेंडर सूची में कैलेंडर का संग्रह. कैलेंडर बनाम 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" - कैलेंडर का मालिकाना हक देता है. इस भूमिका में, लेखक की भूमिका की सभी अनुमतियां हैं. इन अनुमतियों में, एसीएल को देखने और उनमें बदलाव करने की अन्य सुविधाएं शामिल हैं.
backgroundColor string हेक्साडेसिमल फ़ॉर्मैट "#0088aa" में कैलेंडर का मुख्य रंग. यह प्रॉपर्टी, इंडेक्स पर आधारित colorId प्रॉपर्टी की जगह लेती है. इस प्रॉपर्टी को सेट करने या बदलने के लिए, आपको insert, update और patch तरीकों के पैरामीटर में, 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, update और patch तरीकों के पैरामीटर में, 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 कैलेंडर का समय क्षेत्र. ज़रूरी नहीं. रीड-ओनली.

तरीके

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