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

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

list अनुरोध, उस अनुरोध से मेल खाना चाहिए जिससे यह टोकन मिला है.
materialDriveId

string

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

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

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

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

कोर्स वर्क का कॉन्टेंट लिस्ट करते समय मिलने वाला जवाब.

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

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

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