Google Classroom API

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

שירות: classroom.googleapis.com

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

מסמך Discovery

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

נקודת קצה (endpoint) של שירות

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

  • https://classroom.googleapis.com

REST Resource: v1.courses

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

שיטות
create POST /v1/courses/{courseId}/aliases
יצירת כתובת אימייל חלופית לקורס.
delete DELETE /v1/courses/{courseId}/aliases/{alias}
מחיקת כתובת אימייל חלופית של קורס.
list GET /v1/courses/{courseId}/aliases
מחזירה רשימה של כתובות אימייל חלופיות של קורס.

REST Resource: 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 Resource: 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 Resource: 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 Resource: 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

שיטות
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
מחזירה רשימה של אפוטרופוסים שהמשתמש המבקש מורשה להציג, מוגבל לאפוטרופוסים שתואמים לבקשה.