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

Events: list

तय किए गए कैलेंडर पर इवेंट दिखाता है. इसे अभी आज़माएं या उदाहरण देखें.

अनुरोध

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

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

पैरामीटर

पैरामीटर का नाम	मान	ब्यौरा
पाथ पैरामीटर
`calendarId`	`string`	कैलेंडर आइडेंटिफ़ायर. कैलेंडर आईडी वापस पाने के लिए, calendarList.list तरीके को कॉल करें. अगर आपको उस उपयोगकर्ता का मुख्य कैलेंडर ऐक्सेस करना है जिसने फ़िलहाल लॉग इन किया हुआ है, तो "`primary`" का इस्तेमाल करें कीवर्ड.
वैकल्पिक क्वेरी पैरामीटर
`alwaysIncludeEmail`	`boolean`	बहिष्कृत और अनदेखा किया गया.
`eventTypes`	`string`	दिखाए जाने वाले इवेंट के टाइप. ज़रूरी नहीं. अलग-अलग टाइप के इवेंट दिखाने के लिए, इस पैरामीटर को कई बार दोहराया जा सकता है. अगर यह नीति सेट नहीं है, तो सभी तरह के इवेंट दिखाता है. ये वैल्यू स्वीकार की जाती हैं: "`default`": नियमित इवेंट. "`focusTime`": फ़ोकस टाइम इवेंट. "`fromGmail`": Gmail के इवेंट. "`outOfOffice`": अभी मैं छुट्टी पर हूं. "`workingLocation`": काम करने की जगह के इवेंट.
`iCalUID`	`string`	रिस्पॉन्स में दिए जाने वाले iCalendar फ़ॉर्मैट में इवेंट आईडी बताता है. ज़रूरी नहीं. अगर किसी इवेंट को उसके iCalendar आईडी से खोजना है, तो इसका इस्तेमाल करें.
`maxAttendees`	`integer`	जवाब में ज़्यादा से ज़्यादा कितने मेहमानों को शामिल करना है. अगर मीटिंग में तय संख्या से ज़्यादा मेहमान मौजूद हैं, तो इवेंट में शामिल व्यक्ति को ही लौटाया जाता है. ज़रूरी नहीं.
`maxResults`	`integer`	नतीजों के एक पेज पर, ज़्यादा से ज़्यादा इवेंट दिखाए जाने की संख्या. नतीजे दिखाने वाले पेज में इवेंट की संख्या इस वैल्यू से कम हो सकती है या बिलकुल भी नहीं हो सकती, भले ही क्वेरी से मिलते-जुलते ज़्यादा इवेंट हों. जवाब में मौजूद `nextPageToken` फ़ील्ड खाली नहीं है. इसकी मदद से अधूरे पेजों की पहचान की जा सकती है. डिफ़ॉल्ट रूप से, यह वैल्यू 250 इवेंट पर सेट होती है. पेज का साइज़ कभी भी 2,500 इवेंट से ज़्यादा नहीं हो सकता. ज़रूरी नहीं.
`orderBy`	`string`	नतीजे में, इवेंट का क्रम. ज़रूरी नहीं. डिफ़ॉल्ट रूप से एक ऐसा क्रम होता है जिसके बारे में जानकारी नहीं होती और जो स्थिर होता है. ये वैल्यू स्वीकार की जाती हैं: "`startTime`": शुरू होने की तारीख/समय के हिसाब से क्रम में लगाएं (बढ़ते क्रम में). यह सिर्फ़ तब उपलब्ध होता है, जब किसी एक इवेंट के लिए क्वेरी की जाती है (यानी पैरामीटर `singleEvents` सही है) "`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` टाइप की, काम करने की जगह की जानकारी का इवेंट दिखाता है या "Abwesend" 'अभी मैं छुट्टी पर हूं' इवेंट दिखाता है. ज़रूरी नहीं.
`sharedExtendedProperty`	`string`	प्रॉपर्टी के लिए बढ़ाए गए कंस्ट्रेंट को, propertyName=value के तौर पर दिखाया जाता है. सिर्फ़ शेयर की गई प्रॉपर्टी से मेल खाता है. इस पैरामीटर को कई बार दोहराया जा सकता है, ताकि सभी दिए गए कंस्ट्रेंट से मेल खाने वाले इवेंट दिखाए जा सकें.
`showDeleted`	`boolean`	क्या मिटाए गए इवेंट (जिनका `status` "`cancelled`" के बराबर है) को नतीजे में शामिल करना है. अगर `showDeleted` और `singleEvents`, दोनों 'गलत' हैं, तो बार-बार होने वाले इवेंट के रद्द किए गए इंस्टेंस को शामिल किया जाएगा. हालांकि, बार-बार होने वाले इवेंट को रद्द नहीं किया जाएगा. अगर `showDeleted` और `singleEvents`, दोनों 'सही' हैं, तो मिटाए गए इवेंट का सिर्फ़ एक इंस्टेंस दिखाया जाता है. हालांकि, बार-बार होने वाले इवेंट का कोई एक इंस्टेंस नहीं दिया जाता. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह वैल्यू 'गलत' पर सेट होती है.
`showHiddenInvitations`	`boolean`	चुनें कि नतीजे में छिपे हुए न्योतों को शामिल करना है या नहीं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह वैल्यू 'गलत' पर सेट होती है.
`singleEvents`	`boolean`	क्या बार-बार होने वाले इवेंट को इंस्टेंस में बड़ा करना है और सिर्फ़ एक बार होने वाले इवेंट और बार-बार होने वाले इवेंट को दिखाना है, लेकिन मूल बार-बार होने वाले इवेंट को नहीं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह वैल्यू 'गलत' पर सेट होती है.
`syncToken`	`string`	सूची के लिए पिछले अनुरोध से मिले नतीजों के आखिरी पेज पर दिखाया गया `nextSyncToken` फ़ील्ड से मिला टोकन. इससे, इस सूची के अनुरोध के नतीजे में सिर्फ़ वे एंट्री शामिल होती हैं जिनमें तब से बदलाव हुए हैं. सूची के पिछले अनुरोध के बाद मिटाए गए सभी इवेंट, हमेशा नतीजे के सेट में शामिल होंगे. `showDeleted` को 'गलत है' पर सेट करने की अनुमति नहीं है. क्लाइंट की स्थिति एक जैसी बनी रहे, यह पक्का करने के लिए कई क्वेरी पैरामीटर को `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`

ज़्यादा जानकारी के लिए, पुष्टि करने और अनुमति देने से जुड़ा पेज देखें.

अनुरोध का मुख्य भाग

इस तरीके के साथ अनुरोध का मुख्य हिस्सा न दें.

जवाब

सही तरीके से काम करने पर, यह तरीका इस स्ट्रक्चर के साथ रिस्पॉन्स का मुख्य हिस्सा दिखाता है:

{
  "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`	इस कैलेंडर के लिए उपयोगकर्ता की ऐक्सेस भूमिका. सिर्फ़ पढ़ने के लिए. संभावित वैल्यू ये हैं: "`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` दिया जाता है.

उदाहरण

ध्यान दें: इस तरीके के लिए दिए गए कोड के उदाहरणों में इसके साथ काम करने वाली सभी प्रोग्रामिंग भाषाएं नहीं दिखाई गई हैं (इसके साथ काम करने वाली भाषाओं की सूची के लिए क्लाइंट लाइब्रेरी वाला पेज देखें).

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 events in the specified calendar
String pageToken = null;
do {
  Events events = service.events().list('primary').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().list(calendarId='primary', 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->listEvents('primary');

while(true) {
  foreach ($events->getItems() as $event) {
    echo $event->getSummary();
  }
  $pageToken = $events->getNextPageToken();
  if ($pageToken) {
    $optParams = array('pageToken' => $pageToken);
    $events = $service->events->listEvents('primary', $optParams);
  } else {
    break;
  }
}

Ruby

Ruby क्लाइंट लाइब्रेरी का इस्तेमाल करता हो.

page_token = nil
begin
  result = client.list_events('primary', page_token: page_token)
  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?

इसे आज़माएं!

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