Settings: list

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

पुष्टि किए गए उपयोगकर्ता की सभी उपयोगकर्ता सेटिंग दिखाता है. इसे अभी आज़माएं.

अनुरोध

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

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

पैरामीटर

पैरामीटर का नाम	मान	ब्यौरा
ज़रूरी नहीं क्वेरी पैरामीटर
maxResults	integer	एक नतीजे वाले पेज पर दिखने वाली एंट्री की ज़्यादा से ज़्यादा संख्या. डिफ़ॉल्ट रूप से, इसकी वैल्यू 100 एंट्री होती है. पेज में 250 से ज़्यादा एंट्री नहीं हो सकतीं. ज़रूरी नहीं.
pageToken	string	यह टोकन बताता है कि कौनसा नतीजा पेज दिखाना है. ज़रूरी नहीं.
syncToken	string	सूची के पिछले अनुरोध के नतीजों के आखिरी पेज पर दिखाए गए nextSyncToken फ़ील्ड से मिला टोकन. इससे, सूची के अनुरोध के नतीजे में सिर्फ़ वे एंट्री शामिल होती हैं जो तब से बदल गई हैं. अगर syncToken की समयसीमा खत्म हो जाती है, तो सर्वर 410 GONE रिस्पॉन्स कोड के साथ जवाब देगा. साथ ही, क्लाइंट को अपना स्टोरेज खाली करना चाहिए और बिना किसी syncToken के पूरा सिंक करना चाहिए. इंक्रीमेंटल सिंक के बारे में ज़्यादा जानें. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, सभी एंट्री दिखती हैं.

अनुमति देना

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

दायरा
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.settings.readonly

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

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

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

जवाब

अगर एपीआई सही से जुड़ जाता है, तो यह तरीका इस स्ट्रक्चर के साथ रिस्पॉन्स बॉडी दिखाता है:

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

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

इसे आज़माएं!

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