CalendarList: list

ध्यान दें: इसके लिए अनुमति ज़रूरी है.

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

अनुरोध

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

GET https://www.googleapis.com/calendar/v3/users/me/calendarList

पैरामीटर

पैरामीटर का नाम	वैल्यू	ब्यौरा
वैकल्पिक क्वेरी पैरामीटर
maxResults	integer	एक नतीजे वाले पेज पर, ज़्यादा से ज़्यादा इतने एंट्री पेज पर लौटाए जा सकते हैं. डिफ़ॉल्ट रूप से, वैल्यू 100 एंट्री होती है. पेज का साइज़ कभी भी 250 एंट्री से ज़्यादा नहीं हो सकता. ज़रूरी नहीं.
minAccessRole	string	दिखाई गई एंट्री में उपयोगकर्ता के लिए ऐक्सेस की कम से कम भूमिका. ज़रूरी नहीं. डिफ़ॉल्ट रूप से कोई पाबंदी नहीं लगाई जाती है. स्वीकार की जाने वाली वैल्यू हैं: "freeBusyReader": उपयोगकर्ता अपने खाली/व्यस्त रहने की जानकारी पढ़ सकता है. "owner": उपयोगकर्ता, इवेंट के साथ-साथ कंट्रोल की सूचियों को पढ़ सकता है और उनमें बदलाव कर सकता है. "reader": उपयोगकर्ता उन इवेंट को पढ़ सकता है जो निजी नहीं हैं. "writer": उपयोगकर्ता, इवेंट पढ़ सकता है और उनमें बदलाव कर सकता है.
pageToken	string	टोकन यह बताता है कि नतीजों के किस पेज को दिखाना है. ज़रूरी नहीं.
showDeleted	boolean	नतीजे में, मिटाई गई कैलेंडर सूची की एंट्री शामिल की जाएं या नहीं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से यह वैल्यू 'गलत' पर सेट होती है.
showHidden	boolean	छिपी हुई एंट्री दिखाएं या नहीं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से यह वैल्यू 'गलत' पर सेट होती है.
syncToken	string	nextSyncToken फ़ील्ड से मिला टोकन, सूची के पिछले अनुरोध के नतीजों के आखिरी पेज पर दिखाया गया. इस सूची से अनुरोध करने पर, सिर्फ़ वही एंट्री शामिल होती हैं जिनमें बदलाव किया गया है. अगर सिर्फ़ रीड ओनली फ़ील्ड, जैसे कि कैलेंडर प्रॉपर्टी या ACL में बदलाव किया गया है, तो एंट्री नहीं दिखेगी. सभी एंट्री मिटा दी गई हैं और छिपी हुई हैं, क्योंकि पिछली सूची के लिए किए गए अनुरोध हमेशा नतीजे के सेट में ही रहेंगे. साथ ही, showDeleted में से किसी भी showHidden को गलत पर सेट नहीं किया जा सकता. यह पक्का करने के लिए कि क्लाइंट की स्थिति एक जैसा हो, minAccessRole क्वेरी पैरामीटर को nextSyncToken के साथ नहीं दिखाया जा सकता. अगर syncToken की समयसीमा खत्म हो जाती है, तो सर्वर 410 GONE रिस्पॉन्स कोड के साथ जवाब देगा. साथ ही, क्लाइंट को अपना स्टोरेज खाली करना होगा और बिना किसी syncToken के पूरी तरह सिंक करना होगा. इंक्रीमेंटल सिंक्रनाइज़ेशन के बारे में ज़्यादा जानें. ज़रूरी नहीं है. डिफ़ॉल्ट रूप से, सभी एंट्री दिखती हैं.

अनुमति देना

इस अनुरोध के लिए, अनुमति देने के लिए, इनमें से कम से कम एक दायरे को शामिल करना ज़रूरी है:

स्कोप
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar

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

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

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

जवाब

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

{
  "kind": "calendar#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}

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

उदाहरण

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

Java

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

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.CalendarList;
import com.google.api.services.calendar.model.CalendarListEntry;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Iterate through entries in calendar list
String pageToken = null;
do {
  CalendarList calendarList = service.calendarList().list().setPageToken(pageToken).execute();
  List<CalendarListEntry> items = calendarList.getItems();

  for (CalendarListEntry calendarListEntry : items) {
    System.out.println(calendarListEntry.getSummary());
  }
  pageToken = calendarList.getNextPageToken();
} while (pageToken != null);

Python

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

page_token = None
while True:
  calendar_list = service.calendarList().list(pageToken=page_token).execute()
  for calendar_list_entry in calendar_list['items']:
    print calendar_list_entry['summary']
  page_token = calendar_list.get('nextPageToken')
  if not page_token:
    break

PHP

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

$calendarList = $service->calendarList->listCalendarList();

while(true) {
  foreach ($calendarList->getItems() as $calendarListEntry) {
    echo $calendarListEntry->getSummary();
  }
  $pageToken = $calendarList->getNextPageToken();
  if ($pageToken) {
    $optParams = array('pageToken' => $pageToken);
    $calendarList = $service->calendarList->listCalendarList($optParams);
  } else {
    break;
  }
}

Ruby

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

page_token = nil
begin
  result = client.list_calendar_lists(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?

इसे आज़माएं!

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