Calendars

सभी मौजूदा कैलेंडर का कलेक्शन. Calendars बनाम CalendarList भी देखें.

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

संसाधन दिखाए जाने के तरीके

{
  "kind": "calendar#calendar",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  },
  "labelProperties": {
    "eventLabels": [
      {
        "id": string,
        "backgroundColor": string,
        "name": string
      }
    ]
  },
  "autoAcceptInvitations": boolean,
  "workingHours": {
    "workingHoursEnabled": boolean,
    "availableTimes": [
      {
        "dayOfWeek": string,
        "periodStart": integer,
        "periodEnd": integer
      }
    ]
  }
}
प्रॉपर्टी का नाम वैल्यू ब्यौरा नोट
autoAcceptInvitations boolean क्या यह कैलेंडर, न्योते अपने-आप स्वीकार करता है. यह सिर्फ़ संसाधन कैलेंडर के लिए मान्य है.
conferenceProperties nested object इस कैलेंडर के लिए कॉन्फ़्रेंसिंग प्रॉपर्टी. उदाहरण के लिए, किस तरह की कॉन्फ़्रेंस की अनुमति है.
conferenceProperties.allowedConferenceSolutionTypes[] list इस कैलेंडर के लिए, कॉन्फ़्रेंसिंग के किस तरह के विकल्प इस्तेमाल किए जा सकते हैं.

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

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

dataOwner string कैलेंडर के मालिक का ईमेल पता. इसे सिर्फ़ सेकंडरी कैलेंडर के लिए सेट किया जाता है. सिर्फ़ पढ़ने के लिए.
description string कैलेंडर की जानकारी. ज़रूरी नहीं. लिखा जा सकता है
etag etag संसाधन का ई-टैग.
id string कैलेंडर का आइडेंटिफ़ायर. आईडी वापस पाने के लिए, calendarList.list() तरीके को कॉल करें.
kind string संसाधन का टाइप ("calendar#calendar").
labelProperties nested object इस कैलेंडर पर तय की गई लेबल प्रॉपर्टी. अगर इसकी वैल्यू दी जाती है, तो यह मौजूदा लेबल प्रॉपर्टी को ओवरराइट कर देता है. अगर कोई वैल्यू नहीं दी जाती है, तो लेबल की प्रॉपर्टी में कोई बदलाव नहीं होता है. लिखा जा सकता है
labelProperties.eventLabels[] list इस कैलेंडर पर तय किए गए इवेंट के लेबल. अगर कैलेंडर अपडेट करते समय यह मौजूद है, तो यह मौजूदा इवेंट लेबल की जगह ले लेगा.

नया इवेंट लेबल जोड़ने के लिए, सूची को बड़ा करें. साथ ही, कैलेंडर से किसी लेबल को मिटाने के लिए, सूची से इकाइयों को हटाएं.

हर कैलेंडर में ज़्यादा से ज़्यादा 200 लेबल हो सकते हैं.

लिखा जा सकता है
labelProperties.eventLabels[].backgroundColor string लेबल के बैकग्राउंड का रंग हेक्साडेसिमल फ़ॉर्मैट में होना चाहिए, जैसे कि "#039be5". इस लेबल वाले इवेंट, इस रंग में दिखते हैं. ज़रूरी है. लिखा जा सकता है
labelProperties.eventLabels[].id string लेबल का आईडी. नया लेबल डालते समय ज़रूरी नहीं है. अगर यह जानकारी नहीं दी जाती है, तो एक यूनीक आईडी जनरेट किया जाएगा. लेबल अपडेट करते समय इसकी ज़रूरत होती है.

अगर आईडी दिया गया है, तो वह कैलेंडर में यूनीक होना चाहिए और यूयूआईडी फ़ॉर्मैट के मुताबिक होना चाहिए.

लिखा जा सकता है
labelProperties.eventLabels[].name string लेबल का नाम. ज़रूरी नहीं.

अगर यह जानकारी दी जाती है, तो इसमें ज़्यादा से ज़्यादा 50 वर्ण होने चाहिए.

लिखा जा सकता है
location string कैलेंडर की भौगोलिक जगह की जानकारी, फ़्री-फ़ॉर्म टेक्स्ट के तौर पर. ज़रूरी नहीं. लिखा जा सकता है
summary string कैलेंडर का टाइटल. लिखा जा सकता है
timeZone string कैलेंडर का टाइम ज़ोन. (आईएएनए टाइम ज़ोन डेटाबेस के नाम के तौर पर फ़ॉर्मैट किया गया, जैसे कि "Europe/Zurich".) ज़रूरी नहीं. लिखा जा सकता है
workingHours object इससे उपयोगकर्ता के काम के घंटों की जानकारी मिलती है. यह सुविधा, Google Workspace उपयोगकर्ताओं के प्राइमरी कैलेंडर के लिए ही उपलब्ध है. काम के घंटे अपडेट करने के लिए, काम के घंटे का पूरा ऑब्जेक्ट पास करना होगा. अगर कोई जानकारी नहीं दी गई है (या शून्य या खाली ऑब्जेक्ट के तौर पर पास किया गया है), तो काम के मौजूदा घंटों में कोई बदलाव नहीं होगा. काम के घंटे बंद करने या शेड्यूल मिटाने के लिए, workingHoursEnabled को false पर सेट करें. साथ ही, availableTimes को छोड़ दें या खाली सूची पास करें. लिखा जा सकता है
workingHours.availableTimes[] list काम के घंटे. उपलब्धता की हर अवधि, उपयोगकर्ता के काम के घंटों के ब्लॉक को दिखाती है. लिखा जा सकता है
workingHours.availableTimes[].dayOfWeek string हफ़्ते का दिन. ज़रूरी है. संभावित वैल्यू ये हैं:
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"
  • "sunday"
लिखा जा सकता है
workingHours.availableTimes[].periodEnd integer दिन के शुरू होने के बाद से, मिनटों में अवधि खत्म होने का समय. इसमें आखिरी मिनट शामिल नहीं होता. ज़रूरी है. लिखा जा सकता है
workingHours.availableTimes[].periodStart integer दिन की शुरुआत से लेकर मिनटों में, अवधि की शुरुआत. इसमें दिन की शुरुआत का समय शामिल है. ज़रूरी है. लिखा जा सकता है
workingHours.workingHoursEnabled boolean इस कैलेंडर के लिए, काम के घंटे दिखाने की सुविधा चालू है या नहीं. availableTimes के खाली होने पर, इसे 'सही है' पर सेट नहीं किया जा सकता. लिखा जा सकता है

तरीके

हटाएं
मुख्य कैलेंडर को मिटाता है. इस कार्रवाई से, किसी खाते के मुख्य कैलेंडर से जुड़े सभी इवेंट मिट जाते हैं.
मिटाएं
सेकंडरी कैलेंडर मिटाता है. मुख्य कैलेंडर के सभी इवेंट मिटाने के लिए, calendars.clear का इस्तेमाल करें.
get
यह फ़ंक्शन, किसी कैलेंडर का मेटाडेटा दिखाता है.
शामिल करें
सेकंडरी कैलेंडर बनाता है.

अनुरोध करने वाले उपयोगकर्ता को नए कैलेंडर के डेटा का मालिक बना दिया जाता है.

patch
किसी कैलेंडर का मेटाडेटा अपडेट करता है. इस तरीके में, पैच सिमैंटिक का इस्तेमाल किया जा सकता है. ध्यान दें कि हर पैच अनुरोध में, कोटे की तीन यूनिट इस्तेमाल होती हैं. इसलिए, get के बाद update का इस्तेमाल करें. आपके दिए गए फ़ील्ड की वैल्यू, मौजूदा वैल्यू की जगह ले लेती हैं. अनुरोध में जिन फ़ील्ड की जानकारी नहीं दी जाती है उनमें कोई बदलाव नहीं होता. अगर अरे फ़ील्ड की जानकारी दी गई है, तो वे मौजूदा अरे को ओवरराइट कर देते हैं. इससे, अरे के पिछले सभी एलिमेंट खारिज हो जाते हैं.
transferOwnership
Google Workspace संगठन के उपयोगकर्ताओं के बीच सेकंडरी कैलेंडर ट्रांसफ़र करता है. इसके लिए, उपयोगकर्ता की पुष्टि करना ज़रूरी है. साथ ही, उसके पास कैलेंडर मैनेज करने का एडमिन अधिकार और इनमें से कोई एक अनुमति होनी चाहिए:
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars
अनुरोध में, useAdminAccess को true पर सेट करें. सेकंडरी कैलेंडर को ट्रांसफ़र करने के लिए, यह ज़रूरी है कि वह चालू हो. बंद या मिटाए गए कैलेंडर ट्रांसफ़र नहीं किए जा सकते.
अपडेट
किसी कैलेंडर का मेटाडेटा अपडेट करता है.