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 जैसे फ़ील्ड इस्तेमाल किए जा सकते हैं. अगर कोई क्रम तय नहीं किया गया है, तो डिफ़ॉल्ट रूप से बढ़ते क्रम में लगाएं. यह "फ़ील्ड [asc|dec], फ़ील्ड [asc|परत], ..." के रूप में होना चाहिए. उदाहरण के लिए, buildingId, capacity desc नतीजों को पहले बढ़ते क्रम में buildingId के हिसाब से दिखाएगा और फिर capacity के हिसाब से घटते क्रम में दिखाएगा.

pageToken

string

सूची में अगला पेज बताने के लिए टोकन.

query

string

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

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

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

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

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

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

जेएसओएन के काेड में दिखाना
{
  "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

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