CalendarList: update

उपयोगकर्ता की कैलेंडर सूची में मौजूदा कैलेंडर को अपडेट करता है. इसे अभी आज़माएं या उदाहरण देखें.

अनुरोध

एचटीटीपी अनुरोध

PUT https://www.googleapis.com/calendar/v3/users/me/calendarList/calendarId

पैरामीटर

पैरामीटर का नाम मान ब्यौरा
पाथ पैरामीटर
calendarId string कैलेंडर आइडेंटिफ़ायर. कैलेंडर आईडी वापस पाने के लिए, calendarList.list तरीके को कॉल करें. अगर आपको उस उपयोगकर्ता का मुख्य कैलेंडर ऐक्सेस करना है जिसने फ़िलहाल लॉग इन किया हुआ है, तो "primary" का इस्तेमाल करें कीवर्ड.
वैकल्पिक क्वेरी पैरामीटर
colorRgbFormat boolean क्या कैलेंडर के रंग (RGB) लिखने के लिए foregroundColor और backgroundColor फ़ील्ड का इस्तेमाल करना है. इस सुविधा का इस्तेमाल करने पर, इंडेक्स पर आधारित colorId फ़ील्ड को, मिलान करने के सबसे अच्छे विकल्प पर अपने-आप सेट कर दिया जाएगा. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह वैल्यू 'गलत' पर सेट होती है.

अनुमति देना

इस अनुरोध के लिए, नीचे दिए गए स्कोप वाले अनुमति की ज़रूरत है:

दायरा
https://www.googleapis.com/auth/calendar

ज़्यादा जानकारी के लिए, पुष्टि करने और अनुमति देने से जुड़ा पेज देखें.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, इन प्रॉपर्टी के साथ CalendarList संसाधन उपलब्ध कराएं:

प्रॉपर्टी का नाम मान ब्यौरा नोट
वैकल्पिक प्रॉपर्टी
backgroundColor string हेक्साडेसिमल फ़ॉर्मैट "#0088aa" में कैलेंडर का मुख्य रंग. यह प्रॉपर्टी, इंडेक्स पर आधारित colorId प्रॉपर्टी की जगह ले लेती है. इस प्रॉपर्टी को सेट करने या बदलने के लिए, आपको शामिल करें, अपडेट, और पैच तरीकों के पैरामीटर में colorRgbFormat=true की जानकारी देनी होगी. ज़रूरी नहीं. लिखा जा सकता है
colorId string कैलेंडर का रंग. यह आईडी, कलर डेफ़िनिशन के calendar सेक्शन में की गई एंट्री को रेफ़र करता है. (कलर एंडपॉइंट देखें). इस प्रॉपर्टी को backgroundColor और foregroundColor प्रॉपर्टी इस्तेमाल करती हैं. इसलिए, इन प्रॉपर्टी का इस्तेमाल करते समय इसे अनदेखा किया जा सकता है. ज़रूरी नहीं. लिखा जा सकता है
defaultReminders[] list ऐसे डिफ़ॉल्ट रिमाइंडर जो पुष्टि किए गए उपयोगकर्ता के पास इस कैलेंडर के लिए हैं. लिखा जा सकता है
defaultReminders[].method string इस रिमाइंडर के लिए इस्तेमाल किया गया तरीका. संभावित वैल्यू ये हैं:
  • "email" - रिमाइंडर, ईमेल से भेजे जाते हैं.
  • "popup" - रिमाइंडर, यूज़र इंटरफ़ेस (यूआई) पॉप-अप के ज़रिए भेजे जाते हैं.

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

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

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

 लिखा जा सकता है
foregroundColor string हेक्साडेसिमल फ़ॉर्मैट "#ffffff" में कैलेंडर का फ़ोरग्राउंड रंग. यह प्रॉपर्टी, इंडेक्स पर आधारित colorId प्रॉपर्टी की जगह ले लेती है. इस प्रॉपर्टी को सेट करने या बदलने के लिए, आपको शामिल करें, अपडेट, और पैच तरीकों के पैरामीटर में colorRgbFormat=true की जानकारी देनी होगी. ज़रूरी नहीं. लिखा जा सकता है
hidden boolean कैलेंडर को सूची में छिपाया गया है या नहीं. ज़रूरी नहीं. यह एट्रिब्यूट सिर्फ़ तब दिखाया जाता है, जब कैलेंडर छिपा होता है. इस स्थिति में वैल्यू true होती है. लिखा जा सकता है
notificationSettings object इस कैलेंडर के लिए, वे सूचनाएं जो पुष्टि किए गए उपयोगकर्ता को मिल रही हैं. लिखा जा सकता है
notificationSettings.notifications[].method string सूचना डिलीवर करने का तरीका. संभावित मान यह है:
  • "email" - सूचनाएं ईमेल से भेजी जाती हैं.

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

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

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

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

जवाब

सही तरीके से काम करने पर, यह तरीका रिस्पॉन्स के मुख्य हिस्से में CalendarList संसाधन दिखाता है.

उदाहरण

ध्यान दें: इस तरीके के लिए दिए गए कोड के उदाहरणों में इसके साथ काम करने वाली सभी प्रोग्रामिंग भाषाएं नहीं दिखाई गई हैं (इसके साथ काम करने वाली भाषाओं की सूची के लिए क्लाइंट लाइब्रेरी वाला पेज देखें).

Java

Java क्लाइंट लाइब्रेरी का इस्तेमाल करता है.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.CalendarListEntry;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Retrieve the calendar list entry
CalendarListEntry calendarListEntry = service.calendarList().get("calendarId").execute();

// Make a change
calendarListEntry.setColorId("newColorId");

// Update the altered entry
CalendarListEntry updatedCalendarListEntry =
    service.calendarList().update(calendarListEntry.getId(), calendarListEntry).execute();

System.out.println(updatedCalendarListEntry.getEtag());

Python

Python क्लाइंट लाइब्रेरी का इस्तेमाल किया जाता है.

# First retrieve the calendarListEntry from the API.
calendar_list_entry = service.calendarList().get(calendarId='calendarId').execute()
calendar_list_entry['colorId'] = 'newColorId'

updated_calendar_list_entry = service.calendarList().update(
    calendarId=calendar_list_entry['id'], body=calendar_list_entry).execute()

print created_calendar_list_entry['etag']

PHP

PHP क्लाइंट लाइब्रेरी का इस्तेमाल किया जाता है.

// First retrieve the calendarListEntry from the API.
$calendarListEntry = $service->calendarList->get('calendarId');
$calendarListEntry->setColorId('newColorId');

$updatedCalendarListEntry = service->calendarList->update($calendarListEntry->getId(), $calendarListEntry);

echo $updatedCalendarListEntry->getEtag();

Ruby

Ruby क्लाइंट लाइब्रेरी का इस्तेमाल करता हो.

calendar_list_entry = client.get_calendar_list('calendarId')
calendar_list_entry.colorId = 'newColorId'
result = client.update_calendar_list(calendar_list_entry.id, calendar_list_entry)
print result.etag

इसे आज़माएं!

लाइव डेटा पर इस तरीके को कॉल करने और जवाब देखने के लिए, नीचे दिए गए एपीआई एक्सप्लोरर का इस्तेमाल करें.