Method: courses.courseWorkMaterials.list

यह अनुरोध करने वाले व्यक्ति को, कोर्स के काम से जुड़ा वह मटीरियल दिखाता है जिसे देखने की अनुमति उसके पास है.

कोर्स में शामिल छात्र-छात्राएं, सिर्फ़ PUBLISHED के तौर पर मार्क किया गया कोर्स का काम देख सकते हैं. कोर्स के शिक्षक और डोमेन के एडमिन, कोर्स के काम से जुड़ा सारा मटीरियल देख सकते हैं.

इस तरीके से, गड़बड़ी के ये कोड मिलते हैं:

  • अगर अनुरोध करने वाले उपयोगकर्ता के पास, अनुरोध किए गए कोर्स को ऐक्सेस करने की अनुमति नहीं है या ऐक्सेस से जुड़ी कोई गड़बड़ी होती है, तो PERMISSION_DENIED कोड मिलता है.
  • अगर अनुरोध गलत फ़ॉर्मैट में किया गया है, तो INVALID_ARGUMENT कोड मिलता है.
  • अगर अनुरोध किया गया कोर्स मौजूद नहीं है, तो NOT_FOUND कोड मिलता है.

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

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWorkMaterials

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

पाथ पैरामीटर

पैरामीटर
courseId

string

कोर्स का आइडेंटिफ़ायर. यह आइडेंटिफ़ायर, Classroom से असाइन किया गया आइडेंटिफ़ायर या alias हो सकता है.

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

पैरामीटर
courseWorkMaterialStates[]

enum (CourseWorkMaterialState)

काम के स्टेटस के आधार पर, नतीजे दिखाने की पाबंदी. सिर्फ़ वे नतीजे दिखाए जाते हैं जो काम के स्टेटस से मेल खाते हैं. अगर कोई पाबंदी नहीं लगाई जाती है, तो PUBLISHED के तौर पर मार्क किए गए आइटम दिखाए जाते हैं.
orderBy

string

नतीजों को क्रम से लगाने का वैकल्पिक तरीका. इसमें, फ़ील्ड की कॉमा लगाकर अलग की गई लिस्ट होती है. साथ ही, क्रम से लगाने की दिशा के लिए वैकल्पिक कीवर्ड भी दिया जा सकता है. updateTime फ़ील्ड के लिए, क्रम से लगाया जा सकता है. क्रम से लगाने की दिशा के लिए, asc और desc कीवर्ड इस्तेमाल किए जा सकते हैं. अगर कोई कीवर्ड नहीं दिया जाता है, तो डिफ़ॉल्ट रूप से updateTime desc का इस्तेमाल किया जाता है. उदाहरण: updateTime asc, updateTime
pageSize

integer

दिखाए जाने वाले आइटम की ज़्यादा से ज़्यादा संख्या. शून्य या कोई संख्या न देने पर, सर्वर ज़्यादा से ज़्यादा संख्या असाइन कर सकता है.

सर्वर, तय की गई संख्या से कम नतीजे दिखा सकता है.
pageToken

string

list कॉल के पिछले जवाब में मिली nextPageToken वैल्यू. इससे पता चलता है कि नतीजों का अगला पेज दिखाया जाना चाहिए.

list का अनुरोध, इस टोकन को जनरेट करने वाले अनुरोध जैसा ही होना चाहिए.
materialDriveId

string

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

enum (PreviewVersion)

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

अनुरोध का मुख्य हिस्सा

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

जवाब का मुख्य हिस्सा

कोर्स के काम से जुड़े मटीरियल की सूची दिखाने पर मिलने वाला जवाब.

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

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "courseWorkMaterial": [
    {
      object (CourseWorkMaterial)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
courseWorkMaterial[]

object (CourseWorkMaterial)

कोर्स के काम से जुड़े वे आइटम जो अनुरोध से मेल खाते हैं.
nextPageToken

string

नतीजों का अगला पेज दिखाने वाला टोकन. अगर यह खाली है, तो इसका मतलब है कि कोई और नतीजा उपलब्ध नहीं है.

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

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

  • https://www.googleapis.com/auth/classroom.courseworkmaterials
  • https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly

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