किसी खास बार-बार होने वाले इवेंट के इंस्टेंस दिखाता है. इसे अभी आज़माएं या उदाहरण देखें.
अनुरोध करें
एचटीटीपी अनुरोध
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId/instances
पैरामीटर
पैरामीटर का नाम | वैल्यू | जानकारी |
---|---|---|
पाथ पैरामीटर | ||
calendarId |
string |
कैलेंडर आइडेंटिफ़ायर. कैलेंडर आईडी फिर से पाने के लिए, calendarList.list तरीके पर कॉल करें. फ़िलहाल, लॉग इन किए हुए उपयोगकर्ता के मुख्य कैलेंडर को ऐक्सेस करने के लिए, "primary " कीवर्ड का इस्तेमाल करें.
|
eventId |
string |
बार-बार होने वाला इवेंट पहचानकर्ता. |
वैकल्पिक क्वेरी पैरामीटर | ||
alwaysIncludeEmail |
boolean |
बहिष्कृत और अनदेखा किया गया. वास्तविक ईमेल पता उपलब्ध होने पर भी आयोजक, निर्माता और उपस्थित व्यक्तियों के लिए email फ़ील्ड में मान लौटाया जाएगा (यानी कि जनरेट किया गया, काम न करने वाला मान दिया जाएगा).
|
maxAttendees |
integer |
जवाब में शामिल होने वाले मेहमानों की ज़्यादा से ज़्यादा संख्या. अगर मीटिंग में शामिल होने वाले लोगों की संख्या, तय संख्या से ज़्यादा है, तो सिर्फ़ उस व्यक्ति को दिखाया जाएगा. ज़रूरी नहीं. |
maxResults |
integer |
किसी नतीजे वाले पेज पर, ज़्यादा से ज़्यादा कितने इवेंट दिखाए गए. डिफ़ॉल्ट रूप से वैल्यू 250 इवेंट होती है. पेज का साइज़ कभी भी 2,500 इवेंट से बड़ा नहीं हो सकता. ज़रूरी नहीं. |
originalStart |
string |
नतीजे में दिखने वाले इंस्टेंस की शुरुआत का समय. ज़रूरी नहीं. |
pageToken |
string |
यह बताता है कि कौनसा नतीजा वाला पेज दिखाना है. ज़रूरी नहीं. |
showDeleted |
boolean |
क्या आपको मिटाए गए इवेंट को शामिल करना है (इसके नतीजे के तौर पर status , "cancelled " के बराबर होगा). अगर singleEvents गलत है, तो बार-बार होने वाले इवेंट के रद्द किए गए इंस्टेंस अब भी शामिल किए जाएंगे. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, 'गलत है' पर क्लिक किया जाता है.
|
timeMax |
datetime |
इवेंट के शुरू होने के समय के हिसाब से फ़िल्टर करने के लिए, ऊपरी सीमा (खास तौर पर). ज़रूरी नहीं. डिफ़ॉल्ट रूप से, शुरुआत के समय के हिसाब से फ़िल्टर न करें. यह एक RFC3339 टाइमस्टैंप होना चाहिए, जिसमें ज़रूरी समय क्षेत्र ऑफ़सेट हो. |
timeMin |
datetime |
इवेंट के खत्म होने के समय के लिए लोअर बाउंड (शामिल). ज़रूरी नहीं. डिफ़ॉल्ट तौर पर, खत्म होने के समय के हिसाब से फ़िल्टर नहीं करना है. यह एक RFC3339 टाइमस्टैंप होना चाहिए, जिसमें ज़रूरी समय क्षेत्र ऑफ़सेट हो. |
timeZone |
string |
जवाब में इस्तेमाल किया गया समय क्षेत्र. ज़रूरी नहीं. कैलेंडर का समय क्षेत्र डिफ़ॉल्ट है. |
अनुमति देना
यह अनुरोध इनमें से कम से कम एक दायरे की अनुमति देता है:
अनुमति देने का |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events.readonly |
https://www.googleapis.com/auth/calendar.events |
ज़्यादा जानकारी के लिए, पुष्टि और अनुमति देना पेज देखें.
अनुरोध का मुख्य भाग
इस तरीके से, अनुरोध का मुख्य हिस्सा न दें.
जवाब
अगर अनुरोध कामयाब रहता है, तो इस रिस्पॉन्स के साथ रिस्पॉन्स का फ़ॉर्मैट नीचे दिया गया है:
{ "kind": "calendar#events", "etag": etag, "summary": string, "description": string, "updated": datetime, "timeZone": string, "accessRole": string, "defaultReminders": [ { "method": string, "minutes": integer } ], "nextPageToken": string, "nextSyncToken": string, "items": [ events Resource ] }
प्रॉपर्टी का नाम | वैल्यू | जानकारी | नोट |
---|---|---|---|
kind |
string |
कलेक्शन का टाइप ("calendar#events "). |
|
etag |
etag |
कलेक्शन का ई-टैग. | |
summary |
string |
कैलेंडर का शीर्षक. रीड-ओनली. | |
description |
string |
कैलेंडर का ब्यौरा. रीड-ओनली. | |
updated |
datetime |
कैलेंडर का आखिरी बदलाव का समय (RFC3339 टाइमस्टैंप के रूप में). रीड-ओनली. | |
timeZone |
string |
कैलेंडर का समय क्षेत्र. रीड-ओनली. | |
accessRole |
string |
इस कैलेंडर के लिए, उपयोगकर्ता के ऐक्सेस की भूमिका. रीड-ओनली. वैल्यू इस तरह की हो सकती हैं:
|
|
defaultReminders[] |
list |
पुष्टि किए गए उपयोगकर्ता के कैलेंडर पर डिफ़ॉल्ट रिमाइंडर. ये रिमाइंडर, इस कैलेंडर के उन सभी इवेंट पर लागू होते हैं जो साफ़ तौर पर उन्हें नहीं बदलते. इसका मतलब, reminders.useDefault को 'सही है' पर सेट नहीं किया जाता. |
|
defaultReminders[].method |
string |
इस रिमाइंडर में इस्तेमाल किया गया तरीका. वैल्यू इस तरह की हो सकती हैं:
रिमाइंडर जोड़ते समय ज़रूरी है. |
लिखा जा सकता है |
defaultReminders[].minutes |
integer |
रिमाइंडर के ट्रिगर होने का समय, इवेंट शुरू होने से इतने मिनट पहले. वैल्यू, 0 से 40320 (मिनट में चार हफ़्ते) के बीच होती हैं. रिमाइंडर जोड़ते समय ज़रूरी है. |
लिखा जा सकता है |
nextPageToken |
string |
इस नतीजे के अगले पेज को ऐक्सेस करने के लिए इस्तेमाल किया गया टोकन. अगर कोई और नतीजा उपलब्ध नहीं होता है, तो इसे छोड़ दिया जाता है. इस स्थिति में nextSyncToken दिया जाता है. |
|
items[] |
list |
कैलेंडर में इवेंट की सूची. | |
nextSyncToken |
string |
टोकन को बाद में कभी-कभी इस्तेमाल किया जाता है, ताकि सिर्फ़ वही एंट्री वापस पाई जा सकें जो इस नतीजे के बाद बदली हैं. अगर आगे के नतीजे उपलब्ध होते हैं, तो इसे छोड़ दिया जाता है. ऐसे में nextPageToken दिया जाता है. |
उदाहरण
ध्यान दें: इस तरीके के लिए दिए गए कोड के उदाहरणों में इसके साथ काम करने वाली सभी प्रोग्रामिंग भाषाएं नहीं दिखाई गई हैं (इसके साथ काम करने वाली भाषाओं की सूची के लिए क्लाइंट लाइब्रेरी वाला पेज देखें).
Java
Java क्लाइंट लाइब्रेरी का इस्तेमाल करता है.
import com.google.api.services.calendar.Calendar; import com.google.api.services.calendar.model.Event; import com.google.api.services.calendar.model.Events; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Iterate over the instances of a specific recurring event String pageToken = null; do { Events events = service.events().instances('primary', 'eventId').setPageToken(pageToken).execute(); List<Event> items = events.getItems(); for (Event event : items) { System.out.println(event.getSummary()); } pageToken = events.getNextPageToken(); } while (pageToken != null);
Python
Python क्लाइंट लाइब्रेरी का इस्तेमाल करता है.
page_token = None while True: events = service.events().instances(calendarId='primary', eventId='eventId', pageToken=page_token).execute() for event in events['items']: print event['summary'] page_token = events.get('nextPageToken') if not page_token: break
PHP
PHP क्लाइंट लाइब्रेरी का इस्तेमाल करता है.
$events = $service->events->instances('primary', "eventId"); while(true) { foreach ($events->getItems() as $event) { echo $event->getSummary(); } $pageToken = $events->getNextPageToken(); if ($pageToken) { $optParams = array('pageToken' => $pageToken); $events = $service->events->instances('primary', "eventId", $optParams); } else { break; } }
Ruby
Ruby क्लाइंट लाइब्रेरी का इस्तेमाल करता है.
page_token = nil begin result = client.list_event_instances('primary', 'eventId') result.items.each do |e| print e.summary + "\n" end if result.next_page_token != page_token page_token = result.next_page_token else page_token = nil end end while !page_token.nil?
इसे आज़माएं!
इस तरीके को लाइव डेटा पर कॉल करने और जवाब देखने के लिए, नीचे दिए गए एपीआई एक्सप्लोरर का इस्तेमाल करें.