इस पेज का अनुवाद Cloud Translation API से किया गया है.

Events: list

यह फ़ंक्शन, बताए गए कैलेंडर में मौजूद इवेंट दिखाता है. इसे अभी आज़माएं.

अनुरोध

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

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events

पैरामीटर

पैरामीटर का नाम	मान	ब्यौरा
पाथ पैरामीटर
`calendarId`	`string`	कैलेंडर का आइडेंटिफ़ायर. कैलेंडर आईडी वापस पाने के लिए, calendarList.list तरीके को कॉल करें. अगर आपको फ़िलहाल लॉग इन किए गए उपयोगकर्ता के प्राइमरी कैलेंडर को ऐक्सेस करना है, तो "`primary`" कीवर्ड का इस्तेमाल करें.
वैकल्पिक क्वेरी पैरामीटर
`alwaysIncludeEmail`	`boolean`	इस विकल्प का इस्तेमाल अब नहीं किया जा सकता और इसे अनदेखा कर दिया जाता है.
`eventTypes`	`string`	लौटाए जाने वाले इवेंट टाइप. ज़रूरी नहीं. अलग-अलग तरह के इवेंट दिखाने के लिए, इस पैरामीटर को कई बार दोहराया जा सकता है. अगर यह नीति सेट नहीं है, तो सभी तरह के इवेंट दिखते हैं. इन वैल्यू का इस्तेमाल किया जा सकता है: "`birthday`": पूरे दिन चलने वाले खास इवेंट, जो हर साल होते हैं. "`default`": नियमित होने वाले इवेंट. "`focusTime`": काम पर फ़ोकस करने के लिए बनाए गए इवेंट. "`fromGmail`": Gmail के इवेंट. "`outOfOffice`": 'अभी मैं छुट्टी पर हूं' इवेंट. "`workingLocation`": काम करने की जगह की जानकारी से जुड़े इवेंट.
`iCalUID`	`string`	यह iCalendar फ़ॉर्मैट में इवेंट का आईडी तय करता है, जिसे जवाब में दिया जाना है. ज़रूरी नहीं. अगर आपको किसी इवेंट को उसके iCalendar आईडी से खोजना है, तो इस फ़िल्टर का इस्तेमाल करें.
`maxAttendees`	`integer`	जवाब में शामिल किए जाने वाले मेहमानों की ज़्यादा से ज़्यादा संख्या. अगर मीटिंग में हिस्सा लेने वाले लोगों की संख्या, तय की गई संख्या से ज़्यादा है, तो सिर्फ़ हिस्सा लेने वाले व्यक्ति की जानकारी मिलती है. ज़रूरी नहीं.
`maxResults`	`integer`	नतीजे वाले एक पेज पर ज़्यादा से ज़्यादा इवेंट दिखाए जाते हैं. ऐसा हो सकता है कि क्वेरी से मेल खाने वाले ज़्यादा इवेंट मौजूद होने के बावजूद, नतीजे वाले पेज में इवेंट की संख्या इस वैल्यू से कम हो या कोई भी इवेंट न हो. जवाब में `nextPageToken` फ़ील्ड की वैल्यू मौजूद होने पर, अधूरे पेजों का पता लगाया जा सकता है. डिफ़ॉल्ट रूप से, इसकी वैल्यू 250 इवेंट होती है. पेज का साइज़, 2,500 इवेंट से ज़्यादा नहीं हो सकता. ज़रूरी नहीं.
`orderBy`	`string`	नतीजे में दिखाए गए इवेंट का क्रम. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, क्रम तय नहीं होता है. हालांकि, यह क्रम स्थिर होता है. इन वैल्यू का इस्तेमाल किया जा सकता है: "`startTime`": शुरू होने की तारीख/समय के हिसाब से क्रमबद्ध करें (बढ़ते क्रम में). यह सुविधा सिर्फ़ तब उपलब्ध होती है, जब किसी एक इवेंट के बारे में क्वेरी की जा रही हो. इसका मतलब है कि पैरामीटर `singleEvents` की वैल्यू True हो "`updated`": पिछली बार बदलाव किए जाने के समय के हिसाब से क्रम से लगाएं (बढ़ते क्रम में).
`pageToken`	`string`	यह टोकन बताता है कि नतीजों का कौनसा पेज दिखाना है. ज़रूरी नहीं.
`privateExtendedProperty`	`string`	propertyName=value के तौर पर बताई गई, एक्सटेंड की गई प्रॉपर्टी की शर्त. सिर्फ़ निजी प्रॉपर्टी से मेल खाता है. यह पैरामीटर कई बार दोहराया जा सकता है, ताकि उन इवेंट को दिखाया जा सके जो दी गई सभी शर्तों को पूरा करते हैं.
`q`	`string`	इन फ़ील्ड में दिए गए शब्दों से मिलते-जुलते इवेंट ढूंढने के लिए, फ़्री टेक्स्ट सर्च टर्म: `summary` `description` `location` मेहमान की `displayName` मेहमान की `email` आयोजक के `displayName` आयोजक के `email` `workingLocationProperties.officeLocation.buildingId` `workingLocationProperties.officeLocation.deskId` `workingLocationProperties.officeLocation.label` `workingLocationProperties.customLocation.label` ये खोज क्वेरी, काम की जगह, छुट्टी पर होने, और काम पर ध्यान देने से जुड़े इवेंट के डिसप्ले टाइटल के सभी अनुवादों के साथ-साथ, पहले से तय किए गए कीवर्ड से भी मैच होती हैं. उदाहरण के लिए, "Office" या "Bureau" खोजने पर, काम करने की जगह से जुड़े `officeLocation` टाइप के इवेंट दिखते हैं. वहीं, "Out of office" या "Abwesend" खोजने पर, छुट्टी पर होने से जुड़े इवेंट दिखते हैं. ज़रूरी नहीं.
`sharedExtendedProperty`	`string`	propertyName=value के तौर पर बताई गई, एक्सटेंड की गई प्रॉपर्टी की शर्त. सिर्फ़ शेयर की गई प्रॉपर्टी से मेल खाता है. यह पैरामीटर कई बार दोहराया जा सकता है, ताकि उन इवेंट को दिखाया जा सके जो दी गई सभी शर्तों को पूरा करते हैं.
`showDeleted`	`boolean`	नतीजे में, मिटाए गए इवेंट (जिनके लिए `status` "`cancelled`" के बराबर है) को शामिल करना है या नहीं. अगर `showDeleted` और `singleEvents`, दोनों की वैल्यू False पर सेट है, तो बार-बार होने वाले इवेंट के रद्द किए गए इंस्टेंस (लेकिन बार-बार होने वाला इवेंट नहीं) अब भी शामिल किए जाएंगे. अगर `showDeleted` और `singleEvents`, दोनों की वैल्यू True है, तो मिटाए गए इवेंट के सिर्फ़ एक इंस्टेंस (लेकिन बार-बार होने वाले इवेंट नहीं) दिखाए जाते हैं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह False पर सेट होता है.
`showHiddenInvitations`	`boolean`	नतीजे में छिपे हुए न्योते शामिल करने हैं या नहीं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह False पर सेट होता है.
`singleEvents`	`boolean`	बार-बार होने वाले इवेंट को इंस्टेंस में बड़ा करना है या नहीं. साथ ही, सिर्फ़ एक बार होने वाले इवेंट और बार-बार होने वाले इवेंट के इंस्टेंस दिखाने हैं, लेकिन बार-बार होने वाले इवेंट नहीं दिखाने हैं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह False पर सेट होता है.
`syncToken`	`string`	यह टोकन, `nextSyncToken` फ़ील्ड से मिलता है. यह फ़ील्ड, सूची के लिए किए गए पिछले अनुरोध के नतीजों के आखिरी पेज पर दिखता है. इससे, सूची के लिए किए गए इस अनुरोध के नतीजे में सिर्फ़ वे एंट्री शामिल होती हैं जिनमें तब से बदलाव हुआ है. पिछली सूची के अनुरोध के बाद से मिटाए गए सभी इवेंट, नतीजे के सेट में हमेशा मौजूद रहेंगे. साथ ही, `showDeleted` को False पर सेट करने की अनुमति नहीं है. ऐसे कई क्वेरी पैरामीटर हैं जिन्हें `nextSyncToken` के साथ नहीं जोड़ा जा सकता. ऐसा इसलिए, ताकि क्लाइंट की स्थिति में एकरूपता बनी रहे. ये हैं: `iCalUID` `orderBy` `privateExtendedProperty` `q` `sharedExtendedProperty` `timeMin` `timeMax` `updatedMin` अन्य सभी क्वेरी पैरामीटर, शुरुआती सिंक्रनाइज़ेशन के लिए इस्तेमाल किए गए पैरामीटर के जैसे ही होने चाहिए, ताकि अनचाहे व्यवहार से बचा जा सके. अगर `syncToken` की समयसीमा खत्म हो जाती है, तो सर्वर 410 GONE रिस्पॉन्स कोड के साथ जवाब देगा. साथ ही, क्लाइंट को अपना स्टोरेज मिटा देना चाहिए और बिना किसी `syncToken` के पूरा सिंक्रनाइज़ेशन करना चाहिए. इंक्रीमेंटल सिंक्रनाइज़ेशन के बारे में ज़्यादा जानें. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, सभी एंट्री दिखाई जाती हैं.
`timeMax`	`datetime`	फ़िल्टर करने के लिए, इवेंट के शुरू होने के समय की ऊपरी सीमा (एक्सक्लूसिव). ज़रूरी नहीं. डिफ़ॉल्ट रूप से, शुरुआत के समय के हिसाब से फ़िल्टर नहीं किया जाता है. यह RFC3339 टाइमस्टैंप होना चाहिए. साथ ही, इसमें टाइम ज़ोन ऑफ़सेट होना ज़रूरी है. उदाहरण के लिए, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. मिलीसेकंड दिए जा सकते हैं, लेकिन उन्हें अनदेखा कर दिया जाता है. अगर `timeMin` सेट है, तो `timeMax` की वैल्यू `timeMin` से ज़्यादा होनी चाहिए.
`timeMin`	`datetime`	फ़िल्टर करने के लिए, इवेंट के खत्म होने के समय की निचली सीमा (एक्सक्लूसिव). ज़रूरी नहीं. डिफ़ॉल्ट रूप से, खत्म होने के समय के हिसाब से फ़िल्टर नहीं किया जाता है. यह RFC3339 टाइमस्टैंप होना चाहिए. साथ ही, इसमें टाइम ज़ोन ऑफ़सेट होना ज़रूरी है. उदाहरण के लिए, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. मिलीसेकंड दिए जा सकते हैं, लेकिन उन्हें अनदेखा कर दिया जाता है. अगर `timeMax` सेट है, तो `timeMin` की वैल्यू `timeMax` से कम होनी चाहिए.
`timeZone`	`string`	जवाब में इस्तेमाल किया गया टाइम ज़ोन. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह कैलेंडर का टाइम ज़ोन होता है.
`updatedMin`	`datetime`	यह किसी इवेंट में आखिरी बार बदलाव किए जाने के समय की सबसे कम सीमा होती है. इसे RFC3339 टाइमस्टैंप के तौर पर दिखाया जाता है. इसका इस्तेमाल फ़िल्टर करने के लिए किया जाता है. अगर यह समय तय किया जाता है, तो इस समय के बाद से मिटाई गई एंट्री हमेशा शामिल की जाएंगी. भले ही, `showDeleted` की वैल्यू कुछ भी हो. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, पिछली बार बदलाव करने के समय के हिसाब से फ़िल्टर नहीं किया जाता है.

अनुमति देना

इस अनुरोध से, कम से कम एक स्कोप के लिए अनुमति मिल सकती है:

दायरा
`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`	कलेक्शन का ईटैग.
`summary`	`string`	कैलेंडर का टाइटल. सिर्फ़ पढ़ने के लिए.
`description`	`string`	कैलेंडर के बारे में जानकारी. सिर्फ़ पढ़ने के लिए.
`updated`	`datetime`	कैलेंडर में पिछली बार बदलाव करने का समय (RFC3339 टाइमस्टैंप के तौर पर). सिर्फ़ पढ़ने के लिए.
`timeZone`	`string`	कैलेंडर का टाइम ज़ोन. सिर्फ़ पढ़ने के लिए.
`accessRole`	`string`	इस कैलेंडर के लिए उपयोगकर्ता की ऐक्सेस भूमिका. सिर्फ़ पढ़ने के लिए. इन वैल्यू का इस्तेमाल किया जा सकता है: "`none`" - उपयोगकर्ता के पास ऐक्सेस नहीं है. "`freeBusyReader`" - इस उपयोगकर्ता के पास, उपलब्धता की जानकारी को पढ़ने का ऐक्सेस है. "`reader`" - इस उपयोगकर्ता के पास कैलेंडर को पढ़ने का ऐक्सेस है. निजी इवेंट, पढ़ने का ऐक्सेस रखने वाले उपयोगकर्ताओं को दिखेंगे. हालांकि, इवेंट की जानकारी छिपी रहेगी. "`writer`" - इस उपयोगकर्ता के पास कैलेंडर को पढ़ने और उसमें बदलाव करने का ऐक्सेस है. निजी इवेंट, लेखक के तौर पर ऐक्सेस रखने वाले उपयोगकर्ताओं को दिखेंगे. साथ ही, उन्हें इवेंट की जानकारी भी दिखेगी. "`owner`" - इस उपयोगकर्ता के पास कैलेंडर का मैनेजर ऐक्सेस है. इस भूमिका में, लेखक की भूमिका वाली सभी अनुमतियां होती हैं. साथ ही, इसमें अन्य उपयोगकर्ताओं के ऐक्सेस लेवल को देखने और उनमें बदलाव करने की सुविधा भी होती है. अहम जानकारी: `owner` की भूमिका, कैलेंडर के डेटा के मालिक की भूमिका से अलग होती है. किसी कैलेंडर का डेटा मालिक एक ही होता है. हालांकि, इसमें `owner` भूमिका वाले कई उपयोगकर्ता हो सकते हैं.
`defaultReminders[]`	`list`	भरोसेमंद व्यक्ति के लिए, कैलेंडर पर डिफ़ॉल्ट रूप से सेट किए गए रिमाइंडर. ये रिमाइंडर, इस कैलेंडर के उन सभी इवेंट पर लागू होते हैं जिनके लिए रिमाइंडर की सेटिंग को साफ़ तौर पर बदला नहीं गया है. इसका मतलब है कि जिन इवेंट के लिए `reminders.useDefault` को 'सही है' पर सेट नहीं किया गया है.
`defaultReminders[].method`	`string`	इस रिमाइंडर के लिए इस्तेमाल किया गया तरीका. इन वैल्यू का इस्तेमाल किया जा सकता है: "`email`" - रिमाइंडर ईमेल से भेजे जाते हैं. "`popup`" - रिमाइंडर, यूज़र इंटरफ़ेस (यूआई) के पॉप-अप के ज़रिए भेजे जाते हैं. रिमाइंडर जोड़ने के लिए यह जानकारी देना ज़रूरी है.	लिखा जा सकता है
`defaultReminders[].minutes`	`integer`	इवेंट शुरू होने से कितने मिनट पहले रिमाइंडर ट्रिगर होना चाहिए. मान्य वैल्यू 0 से 40320 (चार हफ़्ते में मिनट) के बीच होती हैं. रिमाइंडर जोड़ने के लिए यह जानकारी देना ज़रूरी है.	लिखा जा सकता है
`nextPageToken`	`string`	इस टोकन का इस्तेमाल, इस नतीजे के अगले पेज को ऐक्सेस करने के लिए किया जाता है. अगर कोई और नतीजा उपलब्ध नहीं है, तो इसे हटा दिया जाता है. ऐसे मामले में `nextSyncToken` दिया जाता है.
`items[]`	`list`	कैलेंडर में मौजूद इवेंट की सूची.
`nextSyncToken`	`string`	इस टोकन का इस्तेमाल बाद में सिर्फ़ उन एंट्री को वापस पाने के लिए किया जाता है जिनमें इस नतीजे के दिखने के बाद से बदलाव हुआ है. अगर ज़्यादा नतीजे उपलब्ध हैं, तो इसे हटा दिया जाता है. ऐसे मामले में `nextPageToken` दिया जाता है.

इसे आज़माएं!

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