Google Classroom API

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

सेवा: classroom.googleapis.com

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

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

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

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

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

  • https://classroom.googleapis.com

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

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

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

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