Events: instances

बार-बार होने वाले इवेंट के इंस्टेंस दिखाता है. इसे अभी आज़माएं.

अनुरोध

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

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 की वैल्यू False पर सेट है, तो बार-बार होने वाले इवेंट के रद्द किए गए इंस्टेंस अब भी शामिल किए जाएंगे. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह False पर सेट होता है.
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
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" - इस उपयोगकर्ता के पास कैलेंडर का मैनेजर ऐक्सेस है. इस भूमिका में, लेखक की भूमिका वाली सभी अनुमतियां होती हैं. साथ ही, इसमें अन्य उपयोगकर्ताओं के ऐक्सेस लेवल को देखने और उनमें बदलाव करने की सुविधा भी होती है.

defaultReminders[] list भरोसेमंद व्यक्ति के लिए, कैलेंडर पर डिफ़ॉल्ट रूप से सेट किए गए रिमाइंडर. ये रिमाइंडर, इस कैलेंडर के उन सभी इवेंट पर लागू होते हैं जिनके लिए रिमाइंडर की सेटिंग को साफ़ तौर पर बदला नहीं गया है. इसका मतलब है कि जिन इवेंट के लिए reminders.useDefault को 'सही है' पर सेट नहीं किया गया है.
defaultReminders[].method string इस रिमाइंडर के लिए इस्तेमाल किया गया तरीका. इन वैल्यू का इस्तेमाल किया जा सकता है:
  • "email" - रिमाइंडर ईमेल से भेजे जाते हैं.
  • "popup" - रिमाइंडर, यूज़र इंटरफ़ेस (यूआई) के पॉप-अप के ज़रिए भेजे जाते हैं.

रिमाइंडर जोड़ने के लिए यह जानकारी देना ज़रूरी है.

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

रिमाइंडर जोड़ने के लिए यह जानकारी देना ज़रूरी है.

 लिखा जा सकता है
nextPageToken string इस टोकन का इस्तेमाल, इस नतीजे के अगले पेज को ऐक्सेस करने के लिए किया जाता है. अगर कोई और नतीजा उपलब्ध नहीं है, तो इसे हटा दिया जाता है. ऐसे मामले में nextSyncToken दिया जाता है.
items[] list कैलेंडर में मौजूद इवेंट की सूची.
nextSyncToken string इस टोकन का इस्तेमाल बाद में सिर्फ़ उन एंट्री को वापस पाने के लिए किया जाता है जिनमें इस नतीजे के दिखने के बाद से बदलाव हुआ है. अगर ज़्यादा नतीजे उपलब्ध हैं, तो इसे हटा दिया जाता है. ऐसे मामले में nextPageToken दिया जाता है.

इसे आज़माएं!

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