बार-बार होने वाले किसी इवेंट के इंस्टेंस दिखाता है. इसे अभी आज़माएं.
अनुरोध
एचटीटीपी अनुरोध
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId/instances
पैरामीटर
पैरामीटर का नाम | मान | ब्यौरा |
---|---|---|
पाथ पैरामीटर | ||
calendarId |
string |
Calendar आइडेंटिफ़ायर. कैलेंडर आईडी पाने के लिए, 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 |
किसी इवेंट के शुरू होने के समय के लिए ऊपरी सीमा (सिर्फ़ एक्सक्लूज़िव), ताकि उसे फ़िल्टर किया जा सके. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, मीटिंग शुरू होने के समय के हिसाब से फ़िल्टर नहीं किया जाता. यह आरएफ़सी3339 टाइमस्टैंप होना चाहिए, जिसमें ज़रूरी टाइम ज़ोन ऑफ़सेट शामिल हो. |
timeMin |
datetime |
किसी इवेंट के खत्म होने के समय का निचला थ्रेशोल्ड (इसमें शामिल है). ज़रूरी नहीं. डिफ़ॉल्ट रूप से, खत्म होने के समय के हिसाब से फ़िल्टर नहीं किया जाता. यह आरएफ़सी3339 टाइमस्टैंप होना चाहिए, जिसमें ज़रूरी टाइम ज़ोन ऑफ़सेट शामिल हो. |
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 |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.events.freebusy |
https://www.googleapis.com/auth/calendar.events.owned |
https://www.googleapis.com/auth/calendar.events.owned.readonly |
https://www.googleapis.com/auth/calendar.events.public.readonly |
ज़्यादा जानकारी के लिए, पुष्टि और अनुमति पेज देखें.
अनुरोध का मुख्य भाग
इस तरीके का इस्तेमाल करते समय, अनुरोध का मुख्य हिस्सा न दें.
जवाब
अगर एपीआई सही से जुड़ जाता है, तो यह तरीका इस स्ट्रक्चर के साथ रिस्पॉन्स बॉडी दिखाता है:
{ "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 |
कलेक्शन का 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 दिया जाता है. |
इसे आज़माएं!
लाइव डेटा पर इस तरीके को कॉल करने और रिस्पॉन्स देखने के लिए, नीचे दिए गए एपीआई एक्सप्लोरर का इस्तेमाल करें.