ממשק המשתמש של Classroom תומך בחמישה סוגים של עבודות: מטלות, בחנים, שאלות שיש להשיב עליהן בתשובה קצרה, שאלות אמריקאיות וחומרים. ב-Classroom API יש כרגע שלושה מהסוגים האלה, שנקראים CourseWorkType
: מטלות, שאלות עם תשובה קצרה ושאלות אמריקאיות.
כדי לגשת לפונקציונליות הזו, אפשר להשתמש במשאב CourseWork, שמייצג מטלה או שאלה שהוקצו לתלמידים בקורס מסוים, כולל כל החומרים והפרטים הנוספים, כמו תאריך ההגשה או הציון המקסימלי.
בנוסף למשאב CourseWork, אפשר לנהל מטלות שהוגשו באמצעות המשאב StudentSubmission
. בקטעים הבאים מוסבר בהרחבה על הנושאים האלה.
יצירת מטלות
אפשר ליצור מטלות רק בשם המורים של הקורס. ניסיון ליצור מטלות בקורס בשם תלמיד יוביל לשגיאה 403 PERMISSION_DENIED
. באופן דומה, אדמינים בדומיין לא יכולים ליצור מטלות לקורסים שהם לא מלמדים, וניסיון לעשות זאת דרך ה-API יוביל גם לשגיאה 403 PERMISSION_DENIED
.
כשיוצרים מטלות באמצעות השיטה courses.courseWork.create
, אפשר לצרף קישורים כ-materials
, כפי שמוצג בקוד לדוגמה שבהמשך:
Java
Python
התוצאה כוללת מזהה שהוקצה על ידי השרת, שאפשר להשתמש בו כדי להפנות למטלה בבקשות API אחרות.
כדי לכלול חומרים מקושרים במטלה שנוצרה באמצעות Classroom API, צריך להשתמש במשאב קישור ולציין את כתובת ה-URL של היעד. המערכת של Classroom מאחזרת באופן אוטומטי את הכותרת ואת התמונה הממוזערת. ממשק Classroom API תומך גם באופן מקורי בחומרים מ-Google Drive ומ-YouTube. אפשר לכלול אותם במשאב DriveFile או במשאב YouTubeVideo בדרך דומה.
כדי לציין מועד הגשה, מגדירים את השדות dueDate
ו-dueTime
לשעה המתאימה לפי UTC. תאריך היעד חייב להיות בעתיד.
אחזור מטלות ושאלות
תלמידים ומורים בקורס הרלוונטי או אדמינים בדומיין יכולים לאחזר מטלות ושאלות. כדי לאחזר מטלה או שאלה ספציפית, משתמשים ב-courses.courseWork.get. כדי לאחזר את כל המטלות או השאלות (אפשר גם להתאים לקריטריונים מסוימים), משתמשים ב-courses.courseWork.list.
ההיקף הנדרש תלוי בתפקיד של המשתמש המבקש בקורס. אם המשתמש הוא תלמיד/ה, צריך להשתמש באחד מההיקפים הבאים:
https://www.googleapis.com/auth/classroom.coursework.me.readonly
https://www.googleapis.com/auth/classroom.coursework.me
אם המשתמש הוא מורה או מנהל דומיין, צריך להשתמש באחד מההיקפים הבאים:
https://www.googleapis.com/auth/classroom.coursework.students.readonly
https://www.googleapis.com/auth/classroom.coursework.students
הרשאה לאחזר מטלה או שאלה לא מובילה להרשאות גישה לחומרים או למטא-נתונים שלהם. בפועל, המשמעות היא שאדמינים לא יכולים לראות את השם של קובץ מצורף ב-Drive אם הם לא חברים בקורס. אם אתם רוצים לתת לאדמינים גישה לקובצי המשתמשים, תוכלו לעיין במדריך בנושא הענקת גישה ברמת הדומיין.
ניהול התשובות של התלמידים
משאב StudentSubmission
מייצג את העבודה והציון של תלמיד או תלמידה במטלה או בשאלה. משאב StudentSubmission
נוצר באופן משתמע לכל תלמיד או תלמידה כשיוצרים שאלה או מטלה חדשה.
בקטעים הבאים מוסברות פעולות נפוצות לניהול התשובות של התלמידים.
אחזור תשובות של תלמידים
התלמידים יכולים לאחזר את המטלות שלהם, המורים יכולים לאחזר את ההגשות של כל התלמידים בקורסים שלהם, ומנהלי דומיינים יכולים לאחזר את כל העבודות שהוגשו לכל התלמידים בדומיין שלהם. לכל הגשה של תלמיד מוקצה מזהה. אם המזהה ידוע לך, אפשר להשתמש ב-courses.courseWork.studentSubmissions.get
כדי לאחזר אותו.
משתמשים בשיטה courses.courseWork.studentSubmissions.list
כדי לקבל משאבים של StudentSubmission
שתואמים לקריטריונים מסוימים, כפי שמוצג בדוגמה הבאה:
Java
Python
כדי לאחזר משאבים מסוג StudentSubmission
ששייכים לתלמידים מסוימים, מציינים את הפרמטר userId
, כפי שמתואר בדוגמה הבאה:
Java
Python
התלמידים מזוהים לפי המזהה הייחודי או כתובת האימייל של המשתמש, כפי שהם מוחזרים על ידי Google Admin SDK. המשתמש הנוכחי יכול גם להפנות למזהה שלו באמצעות הקיצור "me"
.
אפשר גם לקבל את ההגשות של כל התלמידים בקורס. לשם כך, משתמשים ב-"-"
כ-courseWorkId
, כפי שמוצג בדוגמה הבאה:
Java
service.courses().courseWork().studentSubmissions()
.list(courseId, "-")
.set("userId", userId)
.execute();
Python
service.courses().courseWork().studentSubmissions().list(
courseId=<course ID or alias>,
courseWorkId='-',
userId=<user ID>).execute()
ההיקף הנדרש תלוי בתפקיד של המשתמש המבקש בקורס. אם המשתמש הוא מורה או אדמין דומיין, צריך להשתמש בהיקף הבא:
https://www.googleapis.com/auth/classroom.coursework.students.readonly
https://www.googleapis.com/auth/classroom.coursework.students
אם המשתמש הוא תלמיד/ה, צריך להשתמש בהיקף הבא:
https://www.googleapis.com/auth/classroom.coursework.me.readonly
https://www.googleapis.com/auth/classroom.coursework.me
הרשאה לאחזר מטלה שהוגשה על ידי תלמיד/ה לא מובילה להרשאות גישה לקבצים המצורפים או למטא-נתונים שלהם. בפועל, המשמעות היא שאדמינים לא יכולים לראות את השם של קובץ ב-Drive שמצורף לקורס אם הם לא רשומים לקורס. אם אתם רוצים לתת לאדמינים גישה לקובצי המשתמשים, תוכלו לעיין במדריך בנושא הענקת גישה ברמת הדומיין.
הוספת קבצים מצורפים לתשובה של תלמיד/ה
כדי לצרף קישורים למטלה שהתלמידים שלחו, אפשר לצרף משאב מסוג Link
, DriveFile
או YouTubeVideo
. עושים זאת באמצעות courses.courseWork.studentSubmissions.modifyAttachments
, כפי שמוצג בדוגמה הבאה:
Java
Python
קובץ מצורף מסוג קישור מוגדר לפי כתובת ה-URL של היעד. מערכת Classroom תאחזר באופן אוטומטי את הכותרת ואת התמונה הממוזערת. מידע על החומרים האחרים זמין בדפי העזרה הרלוונטיים.
רק מורה הקורס או התלמיד/ה שבבעלותם הקישור יכולים לשנות את StudentSubmission
. אפשר לצרף את Materials
רק אם הערך של CourseWorkType
בעבודה של התלמיד/ה הוא ASSIGNMENT
.
ההיקף הנדרש תלוי בתפקיד של המשתמש המבקש בקורס. אם המשתמש הוא מורה, צריך להשתמש בהיקף הבא:
https://www.googleapis.com/auth/classroom.coursework.students
אם המשתמש הוא תלמיד/ה, צריך להשתמש בהיקף הבא:
https://www.googleapis.com/auth/classroom.coursework.me