किसी खास बार-बार होने वाले इवेंट के इंस्टेंस दिखाता है. इसे अभी आज़माएं या उदाहरण देखें.
अनुरोध
एचटीटीपी अनुरोध
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?
इसे आज़माएं!
इस तरीके को लाइव डेटा पर कॉल करने और रिस्पॉन्स देखने के लिए, नीचे दिए गए एपीआई एक्सप्लोरर का इस्तेमाल करें.