कैलेंडर के लिए, ऐक्सेस कंट्रोल सूची में मौजूद नियम दिखाता है. इसे अभी आज़माएं या उदाहरण देखें.
अनुरोध
एचटीटीपी अनुरोध
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/acl
पैरामीटर
पैरामीटर का नाम | मान | ब्यौरा |
---|---|---|
पाथ पैरामीटर | ||
calendarId |
string |
कैलेंडर आइडेंटिफ़ायर. कैलेंडर आईडी पाने के लिए, calendarList.list तरीके को कॉल करें. अगर आपको लॉग इन किए हुए उपयोगकर्ता का प्राइमरी कैलेंडर ऐक्सेस करना है, तो "primary " कीवर्ड का इस्तेमाल करें.
|
ज़रूरी नहीं क्वेरी पैरामीटर | ||
maxResults |
integer |
एक नतीजे वाले पेज पर दिखने वाली एंट्री की ज़्यादा से ज़्यादा संख्या. डिफ़ॉल्ट रूप से, इसकी वैल्यू 100 एंट्री होती है. पेज में 250 से ज़्यादा एंट्री नहीं हो सकतीं. ज़रूरी नहीं. |
pageToken |
string |
यह टोकन बताता है कि कौनसा नतीजा पेज दिखाना है. ज़रूरी नहीं. |
showDeleted |
boolean |
नतीजों में मिटाए गए एसीएल शामिल करने हैं या नहीं. मिटाए गए एसीएल को role से दिखाया जाता है, जो "none " के बराबर होता है. अगर syncToken दिया जाता है, तो मिटाए गए एसीएल हमेशा शामिल किए जाएंगे. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह 'गलत' पर सेट होता है.
|
syncToken |
string |
सूची के पिछले अनुरोध के नतीजों के आखिरी पेज पर दिखाए गए nextSyncToken फ़ील्ड से मिला टोकन. इससे, सूची के अनुरोध के नतीजे में सिर्फ़ वे एंट्री शामिल होती हैं जो तब से बदल गई हैं. सूची के पिछले अनुरोध के बाद मिटाई गई सभी एंट्री, नतीजे के सेट में हमेशा मौजूद रहेंगी. साथ ही, showDeleted को False पर सेट करने की अनुमति नहीं है. अगर syncToken की समयसीमा खत्म हो जाती है, तो सर्वर 410 GONE रिस्पॉन्स कोड के साथ जवाब देगा. साथ ही, क्लाइंट को अपना स्टोरेज खाली करना चाहिए और बिना किसी syncToken के पूरा सिंक करना चाहिए. इंक्रीमेंटल सिंक के बारे में ज़्यादा जानें. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, सभी एंट्री दिखाने का विकल्प चुना जाता है. |
अनुमति देना
इस अनुरोध के लिए, इनमें से कम से कम एक स्कोप के साथ अनुमति देना ज़रूरी है:
दायरा |
---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.acls |
https://www.googleapis.com/auth/calendar.acls.readonly |
ज़्यादा जानकारी के लिए, पुष्टि और अनुमति पेज देखें.
अनुरोध का मुख्य भाग
इस तरीके का इस्तेमाल करते समय, अनुरोध का मुख्य हिस्सा न दें.
जवाब
अगर एपीआई सही से जुड़ जाता है, तो यह तरीका इस स्ट्रक्चर के साथ रिस्पॉन्स बॉडी दिखाता है:
{ "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
इसे आज़माएं!
लाइव डेटा पर इस तरीके को कॉल करने और रिस्पॉन्स देखने के लिए, नीचे दिए गए एपीआई एक्सप्लोरर का इस्तेमाल करें.