Google Classroom API

Google Classroom में क्लास, छात्र-छात्राओं की सूचियां, और न्योते मैनेज करना.

सेवा: classroom.googleapis.com

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

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

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

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

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

  • https://classroom.googleapis.com

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

तरीके
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
इससे पता चलता है कि किसी उपयोगकर्ता के पास, किसी कोर्स में ऐड-ऑन अटैचमेंट बनाने की अनुमति है या नहीं.
checkGradingPeriodsSetupEligibility
(deprecated)		 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}
किसी सूचना के एक या उससे ज़्यादा फ़ील्ड अपडेट करता है.

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}
ऐड-ऑन अटैचमेंट के लिए, छात्र या छात्रा के सबमिट किए गए असाइनमेंट को वापस करता है.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions
इससे, छात्र-छात्राओं के सबमिट किए गए उन असाइनमेंट की सूची मिलती है जिन्हें देखने की अनुमति, अनुरोध करने वाले व्यक्ति के पास है.
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.studentGroups

तरीके
create POST /v1/courses/{courseId}/studentGroups
किसी कोर्स के लिए, छात्र-छात्राओं का ग्रुप बनाता है.
delete DELETE /v1/courses/{courseId}/studentGroups/{id}
छात्र-छात्राओं के ग्रुप को मिटाता है.
list GET /v1/courses/{courseId}/studentGroups
यह फ़ंक्शन, किसी कोर्स में मौजूद ग्रुप की सूची दिखाता है.
patch PATCH /v1/courses/{courseId}/studentGroups/{id}
छात्र-छात्राओं के ग्रुप में एक या उससे ज़्यादा फ़ील्ड अपडेट करता है.

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

तरीके
create POST /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
छात्र-छात्राओं के किसी ग्रुप में कोई सदस्य जोड़ता है.
delete DELETE /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId}
छात्र-छात्राओं के ग्रुप के किसी सदस्य को मिटाता है.
list GET /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
इससे किसी ग्रुप में शामिल छात्र-छात्राओं की सूची दिखती है.

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
इससे पता चलता है कि कोई उपयोगकर्ता, 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
यह अभिभावकों की ऐसी सूची दिखाता है जिसे देखने की अनुमति, अनुरोध करने वाले उपयोगकर्ता के पास है. इसमें सिर्फ़ वे अभिभावक शामिल होते हैं जो अनुरोध से मेल खाते हैं.