Google Classroom API

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

שירות: classroom.googleapis.com

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

מסמך Discovery

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

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

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

  • https://classroom.googleapis.com

משאב REST: ‏ v1.courses

Methods
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

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

משאב REST: ‏v1.courses.announcements

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
אחזור מטא-נתונים של תוספים ל-Classroom בהקשר של פוסט ספציפי.

משאב REST: ‏ v1.courses.posts.addOnAttachments

Methods
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

Methods
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

Methods
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

Methods
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 Resource: v1.courses.students

Methods
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 Resource: v1.courses.teachers

Methods
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

Methods
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

Methods
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

Methods
create POST /v1/registrations
יוצר Registration, וגורם ל-Classroom להתחיל לשלוח התראות מה-feed שצוין ליעד שצוין ב-cloudPubSubTopic.
delete DELETE /v1/registrations/{registrationId}
מחיקת Registration, כך ש-Classroom מפסיקה לשלוח התראות לגבי Registration.

משאב REST: ‏ v1.userProfiles

Methods
checkUserCapability GET /v1/userProfiles/{userId}:checkUserCapability
הפונקציה מחזירה ערך שמציין אם המשתמש יכול להשתמש ביכולת שצוינה ב-Classroom.
get GET /v1/userProfiles/{userId}
הפונקציה מחזירה פרופיל משתמש.

משאב REST: ‏v1.userProfiles.guardianInvitations

Methods
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

Methods
delete DELETE /v1/userProfiles/{studentId}/guardians/{guardianId}
מחיקת אפוטרופוס.
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
החזרת הורה או אפוטרופוס ספציפי.
list GET /v1/userProfiles/{studentId}/guardians
הפונקציה מחזירה רשימה של אפוטרופסים שהמשתמש ששלח את הבקשה רשאי לראות, ומוגבלת לאלה שתואמים לבקשה.