Google Classroom API

Google Classroom में क्लास, नामावली, और न्योतों को मैनेज करता है.

सेवा: Classroom.googleapis.com

इस सेवा को कॉल करने के लिए, हमारा सुझाव है कि आप Google की क्लाइंट लाइब्रेरी का इस्तेमाल करें. अगर इस सेवा को कॉल करने के लिए आपके ऐप्लिकेशन को आपकी अपनी लाइब्रेरी का इस्तेमाल करना है, तो एपीआई अनुरोध करते समय नीचे दी गई जानकारी का इस्तेमाल करें.

खोज से जुड़ा दस्तावेज़

डिस्कवरी दस्तावेज़ REST API के बारे में जानकारी देने और उसका इस्तेमाल करने के लिए, इस स्पेसिफ़िकेशन को मशीन से पढ़ सकता है. इसका इस्तेमाल क्लाइंट लाइब्रेरी, IDE प्लगिन, और Google API के साथ इंटरैक्ट करने वाले अन्य टूल बनाने में किया जाता है. एक सेवा, खोज के लिए कई दस्तावेज़ उपलब्ध करा सकती है. खोज से जुड़ा यह दस्तावेज़, इस सेवा पर उपलब्ध है:

सेवा एंडपॉइंट

सेवा एंडपॉइंट एक बेस यूआरएल होता है, जो एपीआई सेवा के नेटवर्क पते के बारे में बताता है. एक सेवा में एक से ज़्यादा सेवा एंडपॉइंट हो सकते हैं. इस सेवा में यह सर्विस एंडपॉइंट है और नीचे दिए गए सभी यूआरआई इस सर्विस एंडपॉइंट से मिलते-जुलते हैं:

  • https://classroom.googleapis.com

REST रिसॉर्स: v1.courses

तरीके
checkAddOnCreationEligibility GET /v1/courses/{courseId}:checkAddOnCreationEligibility
यह जानकारी दिखाता है कि कोई उपयोगकर्ता, दिए गए कोर्स में ऐड-ऑन अटैचमेंट बना सकता है या नहीं.
checkGradingPeriodsSetupEligibility GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
यह जानकारी देता है कि कोई उपयोगकर्ता दिए गए कोर्स में GradingPeriodSettings अपडेट कर सकता है या नहीं.
create POST /v1/courses
कोर्स बनाता है.
delete DELETE /v1/courses/{id}
कोर्स को मिटाता है.
get GET /v1/courses/{id}
कोर्स दिखाता है.
getGradingPeriodSettings GET /v1/courses/{courseId}/gradingPeriodSettings
किसी कोर्स में ग्रेडिंग पीरियड की सेटिंग दिखाता है.
list GET /v1/courses
उन कोर्स की सूची दिखाता है जिन्हें देखने का अनुरोध करने वाले उपयोगकर्ता के पास देखने की अनुमति है. हालांकि, यह सिर्फ़ उन कोर्स की सूची दिखाता है जो अनुरोध से मेल खाते हैं.
patch PATCH /v1/courses/{id}
कोर्स के एक या उससे ज़्यादा फ़ील्ड को अपडेट करता है.
update PUT /v1/courses/{id}
कोर्स को अपडेट करता है.
updateGradingPeriodSettings PATCH /v1/courses/{courseId}/gradingPeriodSettings
यह कोर्स की ग्रेडिंग पीरियड की सेटिंग को अपडेट करता है.

REST रिसॉर्स: v1.courses.aliases

तरीके
create POST /v1/courses/{courseId}/aliases
कोर्स के लिए उपनाम बनाता है.
delete DELETE /v1/courses/{courseId}/aliases/{alias}
कोर्स का उपनाम मिटाता है.
list GET /v1/courses/{courseId}/aliases
किसी कोर्स के लिए, उपनामों की सूची दिखाता है.

REST रिसॉर्स: v1.courses.announcements

तरीके
create POST /v1/courses/{courseId}/announcements
सूचना बनाता है.
delete DELETE /v1/courses/{courseId}/announcements/{id}
किसी सूचना को मिटा देता है.
get GET /v1/courses/{courseId}/announcements/{id}
किसी सूचना को दिखाता है.
getAddOnContext GET /v1/courses/{courseId}/announcements/{itemId}/addOnContext
इसमें किसी खास पोस्ट के लिए, Classroom ऐड-ऑन के मेटाडेटा की जानकारी मिलती है.
list GET /v1/courses/{courseId}/announcements
उन सूचनाओं की सूची दिखाता है जिन्हें अनुरोध करने वाले को देखने की अनुमति है.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
यह असाइनी मोड और किसी सूचना के विकल्पों में बदलाव करता है.
patch PATCH /v1/courses/{courseId}/announcements/{id}
किसी सूचना के एक या उससे ज़्यादा फ़ील्ड को अपडेट करता है.

आरईएसटी संसाधन: v1.courses.announcements.addOnAttachments

तरीके
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
किसी पोस्ट के नीचे ऐड-ऑन अटैचमेंट बनाता है.
delete DELETE /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
ऐड-ऑन अटैचमेंट को मिटाता है.
get GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
ऐड-ऑन अटैचमेंट दिखाता है.
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
पोस्ट के नीचे ऐड-ऑन से बनाए गए सभी अटैचमेंट दिखाता है.
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
ऐड-ऑन अटैचमेंट को अपडेट करता है.

REST रिसॉर्स: v1.courses.courseWork

तरीके
create POST /v1/courses/{courseId}/courseWork
कोर्स वर्क बनाता है.
delete DELETE /v1/courses/{courseId}/courseWork/{id}
कोर्स वर्क को मिटा दिया जाता है.
get GET /v1/courses/{courseId}/courseWork/{id}
कोर्स वर्क दिखाता है.
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
इसमें किसी खास पोस्ट के लिए, Classroom ऐड-ऑन के मेटाडेटा की जानकारी मिलती है.
list GET /v1/courses/{courseId}/courseWork
यह फ़ंक्शन उन कोर्स वर्क की सूची दिखाता है जिन्हें अनुरोध करने वाले को देखने की अनुमति है.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
यह असाइनी मोड और कोर्सवर्क के विकल्पों में बदलाव करता है.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
कोर्स वर्क के एक या उससे ज़्यादा फ़ील्ड अपडेट करता है.

आरईएसटी संसाधन: v1.courses.courseWork.addOnAttachments

तरीके
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
किसी पोस्ट के नीचे ऐड-ऑन अटैचमेंट बनाता है.
delete DELETE /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
ऐड-ऑन अटैचमेंट को मिटाता है.
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
ऐड-ऑन अटैचमेंट दिखाता है.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
पोस्ट के नीचे ऐड-ऑन से बनाए गए सभी अटैचमेंट दिखाता है.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
ऐड-ऑन अटैचमेंट को अपडेट करता है.

REST रिसॉर्स: v1.courses.courseWork.addOnAttachments.studentSubmissions

तरीके
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
यह फ़ंक्शन, किसी ऐड-ऑन अटैचमेंट के लिए छात्र/छात्रा का सबमिट किया गया अनुरोध दिखाता है.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
ऐड-ऑन अटैचमेंट के सबमिशन से जुड़ा डेटा अपडेट करता है.

REST रिसॉर्स: v1.courses.courseWork.rubrics

तरीके
create POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
रूब्रिक बनाता है.
delete DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
रूब्रिक को मिटाता है.
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
रूब्रिक दिखाता है.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
उन रूब्रिक की सूची दिखाता है जिन्हें अनुरोध करने वाले को देखने की अनुमति है.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
रूब्रिक को अपडेट करता है.

REST रिसॉर्स: v1.courses.courseWork.studentSubmissions

तरीके
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
छात्र-छात्राओं का सबमिट किया गया असाइनमेंट दिखाता है.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
छात्र-छात्राओं के उन असाइनमेंट की सूची दिखाता है जिन्हें देखने की अनुमति है. यह सूची, अनुरोध के OAuth दायरों में शामिल की जाती है.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
छात्र-छात्राओं के सबमिट किए गए असाइनमेंट के अटैचमेंट में बदलाव करता है.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
छात्र-छात्राओं के सबमिट किए गए असाइनमेंट के एक या एक से ज़्यादा फ़ील्ड को अपडेट करता है.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
मालिकाना हक रखने वाले छात्र या छात्रा की ओर से, छात्र-छात्रा के असाइनमेंट पर फिर से दावा करे.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
छात्र-छात्राओं का सबमिट किया गया असाइनमेंट दिखाता है.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
इससे छात्र/छात्रा का असाइनमेंट सबमिट हो जाता है.

REST रिसॉर्स: v1.courses.courseWorkMaterials

तरीके
create POST /v1/courses/{courseId}/courseWorkMaterials
कोर्स वर्क का कॉन्टेंट बनाया जाता है.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
कोर्स वर्क के कॉन्टेंट को मिटा दिया जाता है.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
कोर्स वर्क का कॉन्टेंट दिखाता है.
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
इसमें किसी खास पोस्ट के लिए, Classroom ऐड-ऑन के मेटाडेटा की जानकारी मिलती है.
list GET /v1/courses/{courseId}/courseWorkMaterials
कोर्स के काम से जुड़े कॉन्टेंट की वह सूची दिखाता है जिसे अनुरोध करने वाले को देखने की अनुमति है.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
कोर्स वर्क कॉन्टेंट के एक या एक से ज़्यादा फ़ील्ड अपडेट करता है.

REST रिसॉर्स: v1.courses.courseWorkMaterials.addOnAttachments

तरीके
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
किसी पोस्ट के नीचे ऐड-ऑन अटैचमेंट बनाता है.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
ऐड-ऑन अटैचमेंट को मिटाता है.
get GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
ऐड-ऑन अटैचमेंट दिखाता है.
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
पोस्ट के नीचे ऐड-ऑन से बनाए गए सभी अटैचमेंट दिखाता है.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
ऐड-ऑन अटैचमेंट को अपडेट करता है.

REST संसाधन: v1.courses.posts

तरीके
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
इसमें किसी खास पोस्ट के लिए, Classroom ऐड-ऑन के मेटाडेटा की जानकारी मिलती है.

आरईएसटी संसाधन: v1.courses.posts.addOnAttachments

तरीके
create POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments
किसी पोस्ट के नीचे ऐड-ऑन अटैचमेंट बनाता है.
delete DELETE /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
ऐड-ऑन अटैचमेंट को मिटाता है.
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
ऐड-ऑन अटैचमेंट दिखाता है.
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
पोस्ट के नीचे ऐड-ऑन से बनाए गए सभी अटैचमेंट दिखाता है.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
ऐड-ऑन अटैचमेंट को अपडेट करता है.

REST रिसॉर्स: v1.courses.posts.addOnAttachments.studentSubmissions

तरीके
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
यह फ़ंक्शन, किसी ऐड-ऑन अटैचमेंट के लिए छात्र/छात्रा का सबमिट किया गया अनुरोध दिखाता है.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
ऐड-ऑन अटैचमेंट के सबमिशन से जुड़ा डेटा अपडेट करता है.

REST रिसॉर्स: v1.courses.students

तरीके
create POST /v1/courses/{courseId}/students
उपयोगकर्ता को कोर्स के छात्र/छात्रा के तौर पर जोड़ता है.
delete DELETE /v1/courses/{courseId}/students/{userId}
कोर्स के छात्र/छात्रा को मिटा दिया जाता है.
get GET /v1/courses/{courseId}/students/{userId}
किसी कोर्स के छात्र/छात्रा की जानकारी दिखाता है.
list GET /v1/courses/{courseId}/students
इस कोर्स के उन छात्र-छात्राओं की सूची दिखाता है जिन्हें अनुरोध करने वाले को देखने की अनुमति है.

REST रिसॉर्स: v1.courses.teachers

तरीके
create POST /v1/courses/{courseId}/teachers
कोर्स का शिक्षक बनाता है.
delete DELETE /v1/courses/{courseId}/teachers/{userId}
बताए गए शिक्षक को कोर्स से हटाता है.
get GET /v1/courses/{courseId}/teachers/{userId}
कोर्स के शिक्षक की जानकारी दिखाता है.
list GET /v1/courses/{courseId}/teachers
इस कोर्स के उन शिक्षकों की सूची दिखाता है जिन्हें अनुरोध करने वाले को देखने की अनुमति है.

REST संसाधन: v1.courses.topics

तरीके
create POST /v1/courses/{courseId}/topics
विषय बनाता है.
delete DELETE /v1/courses/{courseId}/topics/{id}
किसी विषय को मिटाता है.
get GET /v1/courses/{courseId}/topics/{id}
किसी विषय को दिखाता है.
list GET /v1/courses/{courseId}/topics
उन विषयों की सूची दिखाता है जिन्हें अनुरोध करने वाले को देखने की अनुमति है.
patch PATCH /v1/courses/{courseId}/topics/{id}
किसी विषय के एक या उससे ज़्यादा फ़ील्ड को अपडेट करता है.

REST रिसॉर्स: v1.invitations

तरीके
accept POST /v1/invitations/{id}:accept
न्योते को स्वीकार करके, उसे हटाता है और न्योता पाने वाले उपयोगकर्ता को, बताए गए कोर्स के शिक्षकों या छात्र-छात्राओं (जहां ज़रूरी हो) में जोड़ देता है.
create POST /v1/invitations
न्योता बनाता है.
delete DELETE /v1/invitations/{id}
न्योता मिटा देता है.
get GET /v1/invitations/{id}
न्योता दिखाता है.
list GET /v1/invitations
उन न्योतों की सूची दिखाता है जिन्हें देखने की अनुमति अनुरोध करने वाले उपयोगकर्ता के पास है. हालांकि, यह सिर्फ़ सूची के अनुरोध से मेल खाने वाले न्योतों की सूची दिखाता है.

REST से जुड़ा संसाधन: v1.registrations

तरीके
create POST /v1/registrations
एक Registration बनाता है, जिससे Classroom, दिए गए feed से cloudPubSubTopic में दिए गए डेस्टिनेशन पर सूचनाएं भेजना शुरू कर देता है.
delete DELETE /v1/registrations/{registrationId}
Registration को मिटा देता है, जिसकी वजह से Classroom उस Registration के लिए सूचनाएं भेजना बंद कर देता है.

REST रिसॉर्स: v1.userProfiles

तरीके
get GET /v1/userProfiles/{userId}
उपयोगकर्ता की प्रोफ़ाइल दिखाता है.

REST रिसॉर्स: v1.userProfiles.guardianInvitations

तरीके
create POST /v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
इसके लिए, अभिभावकों को न्योता भेजा जाता है और अभिभावक को ईमेल भेजकर इस बात की पुष्टि करने के लिए कहा जाता है कि वे बच्चे के अभिभावक हैं.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
यह नतीजे के तौर पर अभिभावक को भेजा जाने वाला खास न्योता दिखाता है.
list GET /v1/userProfiles/{studentId}/guardianInvitations
यह नीति, अभिभावक के उन न्योतों की सूची दिखाती है जिन्हें देखने की अनुमति अनुरोध करने वाले उपयोगकर्ता को है. इन न्योतों को दिए गए पैरामीटर के हिसाब से फ़िल्टर किया जाता है.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
अभिभावक के लिए न्योते में बदलाव किया जाता है.

REST रिसॉर्स: v1.userProfiles.guardians

तरीके
delete DELETE /v1/userProfiles/{studentId}/guardians/{guardianId}
अभिभावक को मिटा देता है.
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
किसी अभिभावक को दिखाता है.
list GET /v1/userProfiles/{studentId}/guardians
उन अभिभावकों की सूची दिखाता है जिन्हें अनुरोध करने वाले उपयोगकर्ता को देखने की अनुमति है. इस सूची में सिर्फ़ वही अभिभावक शामिल होते हैं जो अनुरोध से मेल खाते हैं.