Google Classroom API

ניהול הכיתות, מצבי התלמידים וההזמנות ב-Google Classroom.

שירות: classroom.googleapis.com

כדי להתקשר לשירות הזה, מומלץ להשתמש בספריות הלקוח ש-Google מספקת. אם האפליקציה שלכם צריכה להשתמש בספריות משלכם כדי לקרוא לשירות הזה, צריך להשתמש במידע הבא כששולחים את בקשות ה-API.

מסמך Discovery

מסמך Discovery הוא מפרט שקריא למכונות, שמתאר ממשקי API ל-REST ומאפשר שימוש בהם. הוא משמש ליצירת ספריות לקוח, יישומי פלאגין ל-IDE וכלים אחרים שמקיימים אינטראקציה עם Google APIs. שירות אחד יכול לספק כמה מסמכי Discovery. השירות הזה מספק את מסמך הגילוי הבא:

נקודת קצה של שירות

נקודת קצה (endpoint) של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות API. לשירות אחד יכולות להיות כמה נקודות קצה (endpoint) של שירות. לשירות הזה יש את נקודת הקצה הבאה, וכל מזהי ה-URI שבהמשך הם יחסיים לנקודת הקצה הזו:

  • https://classroom.googleapis.com

REST Resource: v1.courses

שיטות
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
הפונקציה מחזירה את הערך 'true' אם המשתמש זכאי ליצור קבצים מצורפים של תוספים בקורס נתון.
checkGradingPeriodsSetupEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
הפונקציה מחזירה אם משתמש מסוים זכאי לעדכן את הגדרות תקופות המטלות בקורס נתון.
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 Resource: 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 Resource: 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
הפונקציה מחזירה רשימה של הורים או אפוטרופוסים שהמשתמש המבקש מורשה לראות, ומוגבלת לאלה שתואמים לבקשה.