Classroom ऐप्लिकेशन में तीन तरह के स्ट्रीम आइटम इस्तेमाल किए जा सकते हैं:
CourseWork
, CourseWorkMaterials
, और Announcements
. इस गाइड में, CourseWork
को मैनेज करने का तरीका बताया गया है. हालांकि, सभी स्ट्रीम आइटम के एपीआई एक जैसे होते हैं. स्ट्रीम आइटम के टाइप और उनके अंतर के बारे में ज़्यादा जानने के लिए, एपीआई संसाधन देखें.
CourseWork
रिसॉर्स, किसी खास कोर्स में छात्रों को असाइन किए गए वर्क आइटम के बारे में बताता है. इसमें, अतिरिक्त कॉन्टेंट और जानकारी भी शामिल होती है. जैसे, सबमिट करने की आखिरी तारीख या ज़्यादा से ज़्यादा मिलने वाले अंक. CourseWork
के चार सब-टाइप होते हैं:
असाइनमेंट, क्विज़ असाइनमेंट, छोटे जवाब वाले सवाल, और
एक से ज़्यादा जवाब वाले सवाल. Classroom API, इनमें से तीन सब-टाइप के साथ काम करता है: असाइनमेंट, छोटे जवाब वाले सवाल, और जवाबों के कई विकल्प वाले सवाल. इन टाइप को CourseWork.workType
फ़ील्ड से दिखाया जाता है.
CourseWork
संसाधन के अलावा, StudentSubmission
संसाधन की मदद से, पूरे हो चुके काम को मैनेज किया जा सकता है.
कोर्सवर्क बनाना
CourseWork
कोर्स के शिक्षक की ओर से सिर्फ़ बनाया जा सकता है.
किसी छात्र या ऐसे डोमेन एडमिन की ओर से CourseWork
बनाने की कोशिश करने पर जो कोर्स में शिक्षक नहीं है, तो आपको PERMISSION_DENIED
गड़बड़ी का मैसेज दिखेगा. Classroom में अलग-अलग भूमिकाओं के बारे में ज़्यादा जानने के लिए, उपयोगकर्ताओं के टाइप लेख पढ़ें.
courses.courseWork.create
तरीके का इस्तेमाल करके CourseWork
बनाते समय, लिंक को materials
के तौर पर अटैच किया जा सकता है. इस बारे में यहां दिए गए सैंपल कोड में बताया गया है:
title
और workType
फ़ील्ड की वैल्यू देना ज़रूरी है. बाकी सभी फ़ील्ड ज़रूरी नहीं हैं.
अगर state
की वैल्यू नहीं दी गई है, तो CourseWork
को ड्राफ़्ट के तौर पर बनाया जाता है.
CourseWork
में लिंक किए गए कॉन्टेंट को शामिल करने के लिए, किसी टारगेट के साथ लिंक किए गए संसाधन का इस्तेमाल करेंurl
. Classroom, title
और थंबनेल इमेज के यूआरएल (thumbnailUrl
) को अपने-आप फ़ेच करता है. Classroom API, Google Drive और YouTube के कॉन्टेंट के साथ भी काम करता है. इन्हें DriveFile
resource या YouTubeVideo
resource के साथ उसी तरह शामिल किया जा सकता है.
पेमेंट की आखिरी तारीख तय करने के लिए, dueDate
और dueTime
फ़ील्ड को यूटीसी समय पर सेट करें. पेमेंट की तारीख, आने वाले समय की होनी चाहिए.
CourseWork
रिस्पॉन्स में, सर्वर से असाइन किया गया आइडेंटिफ़ायर शामिल होता है. इसका इस्तेमाल, अन्य एपीआई अनुरोधों में असाइनमेंट का रेफ़रंस देने के लिए किया जा सकता है.
कोर्सवर्क वापस पाना
आपके पास उस कोर्स के छात्र-छात्राओं और शिक्षकों की ओर से CourseWork
को वापस पाने का विकल्प है. डोमेन एडमिन की ओर से भी CourseWork
को वापस पाया जा सकता है. भले ही, वे कोर्स में शिक्षक न हों. किसी खास CourseWork
को वापस पाने के लिए, courses.courseWork.get
का इस्तेमाल करें. सभी CourseWork
(ज़रूरी नहीं कि वे कुछ शर्तों को पूरा करते हों) को वापस पाने के लिए, courses.courseWork.list
का इस्तेमाल करें.
ज़रूरी दायरा, कोर्स में अनुरोध करने वाले उपयोगकर्ता की भूमिका पर निर्भर करता है. अगर उपयोगकर्ता छात्र या छात्रा है, तो इनमें से किसी एक स्कोप का इस्तेमाल करें:
https://www.googleapis.com/auth/classroom.coursework.me.readonly
https://www.googleapis.com/auth/classroom.coursework.me
अगर उपयोगकर्ता शिक्षक या डोमेन एडमिन है, तो इनमें से किसी एक स्कोप का इस्तेमाल करें:
https://www.googleapis.com/auth/classroom.coursework.students.readonly
https://www.googleapis.com/auth/classroom.coursework.students
CourseWork
को वापस पाने की अनुमति होने का मतलब यह नहीं है कि आपके पास कॉन्टेंट या कॉन्टेंट के मेटाडेटा को ऐक्सेस करने की अनुमति है. इसका मतलब है कि अगर कोई एडमिन कोर्स का सदस्य नहीं है, तो हो सकता है कि उसे अटैच की गई Drive फ़ाइल का टाइटल न दिखे.
छात्र-छात्राओं के जवाब मैनेज करना
StudentSubmission
रिसॉर्स से पता चलता है कि किसी CourseWork
के लिए छात्र/छात्रा ने क्या काम किया है. संसाधन में, काम से जुड़ा मेटाडेटा शामिल होता है. जैसे, काम की स्थिति और ग्रेड. नया CourseWork
बनाने पर, हर छात्र/छात्रा के लिए StudentSubmission
अपने-आप बन जाता है.
यहां दिए गए सेक्शन में, छात्र-छात्राओं के जवाबों को मैनेज करने वाली सामान्य कार्रवाइयों के बारे में बताया गया है.
छात्र-छात्राओं के जवाब पाना
छात्र/छात्राएं अपने सबमिशन वापस पा सकते हैं. शिक्षक, अपने कोर्स में शामिल सभी छात्र/छात्राओं के सबमिशन वापस पा सकते हैं. साथ ही, डोमेन एडमिन अपने डोमेन में शामिल सभी छात्र/छात्राओं के सबमिशन वापस पा सकते हैं. हर StudentSubmission
को एक आइडेंटिफ़ायर असाइन किया जाता है. अगर आपको आइडेंटिफ़ायर पता है, तो सबमिट किए गए डेटा को वापस पाने के लिए, courses.courseWork.studentSubmissions.get
का इस्तेमाल करें.
courses.courseWork.studentSubmissions.list
तरीके का इस्तेमाल करके, कुछ शर्तों से मैच करने वाले सभी StudentSubmission
संसाधन पाएं. इसका उदाहरण यहां दिया गया है:
userId
पैरामीटर की मदद से, किसी खास छात्र के StudentSubmission
संसाधनों को पाएं. इसका उदाहरण नीचे दिया गया है:
छात्र-छात्राओं की पहचान, यूनीक आईडी या ईमेल पते से की जाती है. इसकी जानकारी, Student
रिसॉर्स में दी गई है. मौजूदा उपयोगकर्ता, "me"
शॉर्टहैंड का इस्तेमाल करके अपने आईडी का रेफ़रंस भी दे सकता है.
किसी कोर्स में मौजूद सभी असाइनमेंट के लिए, छात्र-छात्राओं के सबमिट किए गए काम भी वापस पाए जा सकते हैं. ऐसा करने के लिए, courseWorkId
के तौर पर लिटरल "-"
का इस्तेमाल करें, जैसा कि इस सैंपल में दिखाया गया है:
service.courses().courseWork().studentSubmissions()
.list(courseId, "-")
.set("userId", userId)
.execute();
service.courses().courseWork().studentSubmissions().list(
courseId=<course ID or alias>,
courseWorkId='-',
userId=<user ID>).execute()
ज़रूरी दायरा, कोर्स में अनुरोध करने वाले उपयोगकर्ता की भूमिका पर निर्भर करता है. अगर उपयोगकर्ता शिक्षक या डोमेन एडमिन है, तो इस स्कोप का इस्तेमाल करें:
https://www.googleapis.com/auth/classroom.coursework.students.readonly
https://www.googleapis.com/auth/classroom.coursework.students
अगर उपयोगकर्ता छात्र या छात्रा है, तो इस स्कोप का इस्तेमाल करें:
https://www.googleapis.com/auth/classroom.coursework.me.readonly
https://www.googleapis.com/auth/classroom.coursework.me
StudentSubmission
को वापस पाने की अनुमति होने का मतलब यह नहीं है कि आपके पास अटैचमेंट या अटैचमेंट के मेटाडेटा को ऐक्सेस करने की अनुमतियां भी हैं. इसका मतलब है कि अगर एडमिन कोर्स का सदस्य नहीं है, तो हो सकता है कि उसे अटैच की गई Drive फ़ाइल का टाइटल न दिखे.
छात्र के जवाब में अटैचमेंट जोड़ना
छात्र-छात्राओं के सबमिट किए गए काम में लिंक अटैच किए जा सकते हैं. इसके लिए, Link
, DriveFile
या YouTubeVideo
संसाधन अटैच करें. ऐसा करने के लिए, courses.courseWork.studentSubmissions.modifyAttachments
का इस्तेमाल किया जाता है. इसका उदाहरण यहां दिया गया है:
Link
अटैचमेंट को टारगेट url
से तय किया जाता है. Classroom, title
और थंबनेल इमेज (thumbnailUrl
) को अपने-आप फ़ेच करता है. StudentSubmissions
से अटैच किए जा सकने वाले कॉन्टेंट के बारे में जानने के लिए, Material
देखें.
StudentSubmission
में सिर्फ़ कोर्स के शिक्षक या उस छात्र/छात्रा के पास बदलाव करने का विकल्प होता है जिसके पास उसका मालिकाना हक होता है. Materials
सिर्फ़ तब अटैच किया जा सकता है, जब StudentSubmission
का CourseWorkType
ASSIGNMENT
हो.
ज़रूरी दायरा, कोर्स में अनुरोध करने वाले उपयोगकर्ता की भूमिका पर निर्भर करता है. अगर उपयोगकर्ता शिक्षक है, तो इस स्कोप का इस्तेमाल करें:
https://www.googleapis.com/auth/classroom.coursework.students
अगर उपयोगकर्ता छात्र या छात्रा है, तो इस स्कोप का इस्तेमाल करें:
https://www.googleapis.com/auth/classroom.coursework.me