Google Classroom API

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

• REST रिसॉर्स: v1.courses
• REST रिसॉर्स: v1.courses.aliases
• REST रिसॉर्स: v1.courses.announcements
• REST रिसॉर्स: v1.courses.announcements.addOnAttachments
• REST रिसॉर्स: v1.courses.courseWork
• REST रिसॉर्स: v1.courses.courseWork.addOnAttachments
• REST रिसॉर्स: v1.courses.courseWork.addOnAttachments.studentSubmissions
• REST रिसॉर्स: v1.courses.courseWork.rubrics
• REST रिसॉर्स: v1.courses.courseWork.studentSubmissions
• REST रिसॉर्स: v1.courses.courseWorkMaterials
• REST रिसॉर्स: v1.courses.courseWorkMaterials.addOnAttachments
• REST रिसॉर्स: v1.courses.posts
• REST रिसॉर्स: v1.courses.posts.addOnAttachments
• REST रिसॉर्स: v1.courses.posts.addOnAttachments.studentSubmissions
• REST रिसॉर्स: v1.courses.students
• REST रिसॉर्स: v1.courses.teachers
• REST रिसॉर्स: v1.courses.topics
• REST रिसॉर्स: v1.invitations
• REST रिसॉर्स: v1.registrations
• REST रिसॉर्स: v1.userProfiles
• REST रिसॉर्स: v1.userProfiles.guardianInvitations
• REST रिसॉर्स: v1.userProfiles.guardians

सेवा: classroom.googleapis.com

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

डिस्कवरी दस्तावेज़

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

• https://classroom.googleapis.com/$discovery/rest?version=v1

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

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

• https://classroom.googleapis.com

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

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

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} किसी सूचना के एक या उससे ज़्यादा फ़ील्ड को अपडेट करता है.

REST रिसॉर्स: 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} कोर्स वर्क के एक या उससे ज़्यादा फ़ील्ड को अपडेट करता है.

REST रिसॉर्स: 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 के ऐड-ऑन का मेटाडेटा पाता है.

REST रिसॉर्स: 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

तरीके
checkUserCapability	GET /v1/userProfiles/{userId}:checkUserCapability डेवलपर के लिए झलक: यह Google Workspace के डेवलपर के लिए झलक वाले प्रोग्राम के तहत उपलब्ध है. इस प्रोग्राम में, कुछ सुविधाओं को रिलीज़ होने से पहले इस्तेमाल करने का ऐक्सेस मिलता है. यह सुविधा V1_20240930_PREVIEW और उसके बाद के वर्शन में उपलब्ध है. ज़्यादा जानने के लिए, झलक देखने के लिए एपीआई ऐक्सेस करें देखें. इससे पता चलता है कि कोई उपयोगकर्ता, Classroom की बताई गई सुविधा का इस्तेमाल कर सकता है या नहीं.
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 उन अभिभावकों की सूची दिखाता है जिन्हें अनुरोध करने वाले उपयोगकर्ता को देखने की अनुमति है. यह सूची, अनुरोध से मेल खाने वाले अभिभावकों तक ही सीमित होती है.