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