Method: resources.calendars.list

यह किसी खाते के लिए, कैलेंडर संसाधनों की सूची वापस लाता है.

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

GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/resources/calendars

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ पैरामीटर

पैरामीटर
customer

string

ग्राहक के Google Workspace खाते का यूनीक आईडी. खाते के एडमिन के तौर पर, अपने खाते के ग्राहक आईडी को दिखाने के लिए my_customer उपनाम का इस्तेमाल भी किया जा सकता है.

क्वेरी पैरामीटर

पैरामीटर
maxResults

integer

ज़्यादा से ज़्यादा कितने नतीजे दिखाने हैं.
orderBy

string

नतीजों को बढ़ते या घटते क्रम में लगाने के लिए फ़ील्ड. resourceId, resourceName, capacity, buildingId, और floorName जैसे फ़ील्ड इस्तेमाल किए जा सकते हैं. अगर कोई क्रम नहीं दिया गया है, तो डिफ़ॉल्ट रूप से बढ़ते क्रम में लगाया जाता है. यह "field [asc|desc], field [asc|desc], ..." फ़ॉर्मैट में होना चाहिए. उदाहरण के लिए, buildingId, capacity desc से मिलने वाले नतीजे, पहले buildingId के हिसाब से बढ़ते क्रम में और फिर capacity के हिसाब से घटते क्रम में क्रम से लगाए जाएंगे.
pageToken

string

यह टोकन, सूची में मौजूद अगले पेज के बारे में बताता है.
query

string

नतीजों को फ़िल्टर करने के लिए इस्तेमाल की गई स्ट्रिंग क्वेरी. इसमें एक या उससे ज़्यादा खोज क्लॉज़ होते हैं. हर क्लॉज़ में एक फ़ील्ड, ऑपरेटर, और वैल्यू होती है. फ़ील्ड, इस्तेमाल किए जा सकने वाले फ़ील्ड में से कोई भी हो सकता है. साथ ही, ऑपरेटर, इस्तेमाल किए जा सकने वाले ऑपरेटर में से कोई भी हो सकता है. ऑपरेटर में, एग्ज़ैक्ट मैच के लिए '=', मैच न होने के लिए '!=', और प्रीफ़िक्स मैच या HAS मैच के लिए ':' शामिल है. प्रीफ़िक्स मैच के लिए, वैल्यू के बाद हमेशा * होना चाहिए. लॉजिकल ऑपरेटर NOT और AND का इस्तेमाल किया जा सकता है. हालांकि, इनका इस्तेमाल इसी क्रम में किया जाना चाहिए. इन फ़ील्ड में जानकारी डाली जा सकती है: generatedResourceName, name, buildingId, floorName, capacity, featureInstances.feature.name, resourceEmail, resourceCategory. उदाहरण के लिए buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone.

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

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

सार्वजनिक एपीआई: Resources.calendars

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना 
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (CalendarResource)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
kind

string

यह CalendarResources के कलेक्शन के तौर पर इसकी पहचान करता है. यह हमेशा admin#directory#resources#calendars#calendarResourcesList होता है.
etag

string

संसाधन का ETag.
items[]

object (CalendarResource)

नतीजों के इस पेज में मौजूद CalendarResources.
nextPageToken

string

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

अनुमति पाने के लिंक

इसके लिए, इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://apps-apis.google.com/a/feeds/calendar/resource/
  • https://www.googleapis.com/auth/admin.directory.resource.calendar
  • https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.