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

इसे आज़माएं!

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