कैलेंडर के लिए ऐक्सेस कंट्रोल सूची में नियमों को दिखाता है. इसे अभी आज़माएं या उदाहरण देखें.
अनुरोध
एचटीटीपी अनुरोध
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/acl
पैरामीटर
पैरामीटर का नाम | मान | ब्यौरा |
---|---|---|
पाथ पैरामीटर | ||
calendarId |
string |
कैलेंडर आइडेंटिफ़ायर. कैलेंडर आईडी वापस पाने के लिए, calendarList.list तरीके को कॉल करें. अगर आपको उस उपयोगकर्ता का मुख्य कैलेंडर ऐक्सेस करना है जिसने फ़िलहाल लॉग इन किया हुआ है, तो "primary " का इस्तेमाल करें कीवर्ड.
|
वैकल्पिक क्वेरी पैरामीटर | ||
maxResults |
integer |
नतीजे के एक पेज पर लौटाए गए गए एंट्री की ज़्यादा से ज़्यादा संख्या. डिफ़ॉल्ट रूप से, वैल्यू 100 एंट्री होती हैं. पेज का साइज़ कभी भी 250 से ज़्यादा नहीं हो सकता. ज़रूरी नहीं. |
pageToken |
string |
यह बताने वाला टोकन कि नतीजा वाला कौनसा पेज दिखाना है. ज़रूरी नहीं. |
showDeleted |
boolean |
क्या मिटाए गए ACL को नतीजे में शामिल करना है. मिटाए गए ACL को "none " के बराबर role से दिखाया जाता है. अगर syncToken दिया गया है, तो मिटाए गए एसीएल हमेशा शामिल किए जाएंगे. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह वैल्यू 'गलत' पर सेट होती है.
|
syncToken |
string |
सूची के लिए पिछले अनुरोध से मिले नतीजों के आखिरी पेज पर दिखाया गया nextSyncToken फ़ील्ड से मिला टोकन. इससे, इस सूची के अनुरोध के नतीजे में सिर्फ़ वे एंट्री शामिल होती हैं जिनमें तब से बदलाव हुए हैं. सूची के पिछले अनुरोध के बाद मिटाई गई सभी एंट्री, हमेशा नतीजे के सेट में शामिल होंगी. साथ ही, showDeleted को 'गलत है' पर सेट करने की अनुमति नहीं है. अगर syncToken की समयसीमा खत्म हो जाती है, तो सर्वर 410 GONE रिस्पॉन्स कोड के साथ जवाब देगा. क्लाइंट को डिवाइस का स्टोरेज खाली करना होगा और syncToken के बिना ही पूरा सिंक करना होगा. समय-समय पर सिंक करने की सुविधा के बारे में ज़्यादा जानें. ज़रूरी नहीं. डिफ़ॉल्ट तौर पर, सभी एंट्री दिखाता है. |
अनुमति देना
इस अनुरोध के लिए, नीचे दिए गए स्कोप वाले अनुमति की ज़रूरत है:
दायरा |
---|
https://www.googleapis.com/auth/calendar |
ज़्यादा जानकारी के लिए, पुष्टि करने और अनुमति देने से जुड़ा पेज देखें.
अनुरोध का मुख्य भाग
इस तरीके के साथ अनुरोध का मुख्य हिस्सा न दें.
जवाब
सही तरीके से काम करने पर, यह तरीका इस स्ट्रक्चर के साथ रिस्पॉन्स का मुख्य हिस्सा दिखाता है:
{ "kind": "calendar#acl", "etag": etag, "nextPageToken": string, "nextSyncToken": string, "items": [ acl Resource ] }
प्रॉपर्टी का नाम | मान | ब्यौरा | नोट |
---|---|---|---|
kind |
string |
कलेक्शन का टाइप ("calendar#acl "). |
|
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.Acl; import com.google.api.services.calendar.model.AclRule; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Iterate over a list of access rules Acl acl = service.acl().list('primary').execute(); for (AclRule rule : acl.getItems()) { System.out.println(rule.getId() + ": " + rule.getRole()); }
Python
Python क्लाइंट लाइब्रेरी का इस्तेमाल किया जाता है.
acl = service.acl().list(calendarId='primary').execute() for rule in acl['items']: print '%s: %s' % (rule['id'], rule['role'])
PHP
PHP क्लाइंट लाइब्रेरी का इस्तेमाल किया जाता है.
$acl = $service->acl->listAcl('primary'); foreach ($acl->getItems() as $rule) { echo $rule->getId() . ': ' . $rule->getRole(); }
Ruby
Ruby क्लाइंट लाइब्रेरी का इस्तेमाल करता हो.
result = client.list_acls('primary') result.items.each do |e| print e.id + ": " + e.role + "\n" end
इसे आज़माएं!
लाइव डेटा पर इस तरीके को कॉल करने और जवाब देखने के लिए, नीचे दिए गए एपीआई एक्सप्लोरर का इस्तेमाल करें.