REST Resource: courses

מקור מידע: קורס

קורס ב-Classroom.

ייצוג ב-JSON 
{
  "id": string,
  "name": string,
  "section": string,
  "descriptionHeading": string,
  "description": string,
  "room": string,
  "ownerId": string,
  "creationTime": string,
  "updateTime": string,
  "enrollmentCode": string,
  "courseState": enum (CourseState),
  "alternateLink": string,
  "teacherGroupEmail": string,
  "courseGroupEmail": string,
  "teacherFolder": {
    object (DriveFolder)
  },
  "courseMaterialSets": [
    {
      object (CourseMaterialSet)
    }
  ],
  "guardiansEnabled": boolean,
  "calendarId": string,
  "gradebookSettings": {
    object (GradebookSettings)
  },
  "subject": string,
  "learningStandardSettings": {
    object (CourseLearningStandardSettings)
  },
  "levels": string
}
שדות
id

string

המזהה של הקורס הזה שהוקצה על ידי Classroom.

כאשר creating a course, אפשר להגדיר את המזהה הזה ל-alias string בבקשה כדי ליצור כינוי תואם. ה-id עדיין מוקצה על ידי Classroom ואי אפשר לעדכן אותו אחרי שהקורס נוצר.

אם מציינים את השדה הזה במסכת עדכון של קורס, מתקבלת שגיאה.
name

string

שם הקורס. לדוגמה, "ביולוגיה לכיתה י'". חובה להזין שם. הוא צריך להיות באורך של תו אחד עד 750 תווים, ולהיות מחרוזת UTF-8 תקינה.
section

string

הקטע של הקורס. לדוגמה, "שיעור 2". אם מאכלסים אותו, השדה הזה צריך להיות מחרוזת UTF-8 תקינה באורך של עד 2,800 תווים.
descriptionHeading

string

כותרת אופציונלית לתיאור. לדוגמה, "ברוכים הבאים לשיעור ביולוגיה של כיתה י'". אם מאכלסים אותו, השדה הזה צריך להיות מחרוזת UTF-8 תקינה באורך של עד 3,600 תווים.
description

string

תיאור אופציונלי. לדוגמה, "נלמד על המבנה של יצורים חיים באמצעות שילוב של ספרי לימוד, הרצאות אורח ועבודה במעבדה. צפויה לכם חוויה מרגשת!" אם מאכלסים אותו, השדה הזה צריך להיות מחרוזת UTF-8 תקינה באורך של עד 30,000 תווים.
room

string

מיקום החדר (אופציונלי). לדוגמה, "301". אם מאכלסים אותו, הערך בשדה הזה צריך להיות מחרוזת UTF-8 תקינה באורך של עד 650 תווים.
ownerId

string

המזהה של הבעלים של הקורס.

כשמציינים את השדה הזה כפרמטר של create course request, הוא שדה חובה. המזהה יכול להיות אחד מהבאים:

  • המזהה המספרי של המשתמש
  • כתובת האימייל של המשתמש
  • המחרוזת המילולית "me", שמציינת את המשתמש ששלח את הבקשה

צריך להגדיר את זה בבקשת יצירה. אדמינים יכולים גם לציין את השדה הזה בpatch course request כדי להעביר בעלות. בהקשרים אחרים, הוא לקריאה בלבד.
creationTime

string (Timestamp format)

מועד היצירה של הקורס. אם מציינים את השדה הזה במסכת עדכון של קורס, מתקבלת שגיאה.

לקריאה בלבד.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: "2014-10-02T15:01:23Z",‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

השעה שבה הקורס עודכן לאחרונה. אם מציינים את השדה הזה במסכת עדכון של קורס, מתקבלת שגיאה.

לקריאה בלבד.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: "2014-10-02T15:01:23Z",‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
enrollmentCode

string

קוד ההרשמה שצריך להשתמש בו כדי להצטרף לקורס הזה. אם מציינים את השדה הזה במסכת עדכון של קורס, מתקבלת שגיאה.

לקריאה בלבד.
courseState

enum (CourseState)

מצב הקורס. אם לא מצוין ערך, מצב ברירת המחדל הוא PROVISIONED.
teacherGroupEmail

string

כתובת האימייל של קבוצת Google שכוללת את כל המורים בקורס. הקבוצה הזו לא מקבלת אימיילים ואפשר להשתמש בה רק להרשאות.

לקריאה בלבד.
courseGroupEmail

string

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

לקריאה בלבד.
teacherFolder

object (DriveFolder)

מידע על תיקייה ב-Drive שמשותפת עם כל המורים בקורס.

השדה הזה יוגדר רק למורים בקורס ולאדמינים בדומיין.

לקריאה בלבד.
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

קבוצות של חומרים שמופיעים בדף "מידע כללי" של הקורס הזה.

לקריאה בלבד.
guardiansEnabled

boolean

האם ההתראות להורים ולאפוטרופסים מופעלות בקורס הזה.

לקריאה בלבד.
calendarId

string

מזהה היומן של יומן שכל חברי הקורס יכולים לראות, שאליו Classroom מוסיף אירועים לעבודות בקורס ולהודעות בקורס.

היומן של הקורס נוצר באופן אסינכרוני כשהקורס מוגדר ל-CourseState.ACTIVE בפעם הראשונה (בזמן היצירה או כשהוא מתעדכן ל-ACTIVE דרך ממשק המשתמש או ה-API). מזהה היומן יאוכלס רק אחרי שתהליך היצירה יושלם.

לקריאה בלבד.
gradebookSettings

object (GradebookSettings)

ההגדרות של גיליון הציונים שקובעות איך הציון הכולל של התלמיד בקורס יחושב ולמי הוא יוצג.

לקריאה בלבד.
subject

string

אופציונלי. נושא הקורס.
learningStandardSettings

object (CourseLearningStandardSettings)

אופציונלי.

הגדרות שקשורות לדרישות הלימודיות שזמינות בקורס. כל קורס יכול לכלול עד 20 קבוצות של מדדי הערכה.
levels

string

אופציונלי. רמות הקורס. דוגמאות: "כיתה ט'", "חטיבת ביניים", "כיתות ד'-ה'", "גן חובה עד כיתה ב'", "3000". אם מאכלסים אותו, השדה הזה צריך להיות מחרוזת UTF-8 תקינה של עד 1,000 תווים.

אפשר לנקות את השדה הזה רק באמצעות השיטה courses.patch.

CourseState

המצבים האפשריים של קורס.

טיפוסים בני מנייה (enum)
COURSE_STATE_UNSPECIFIED אין סטטוס קורס. הערך הזה לא ישמש באף הודעה על קורס שהוחזר.
ACTIVE הקורס פעיל.
ARCHIVED הקורס הועבר לארכיון. אי אפשר לשנות אותו, חוץ מאשר להעביר אותו למצב אחר.
PROVISIONED הקורס נוצר, אבל עדיין לא הופעל. המורה הראשי ואדמינים בדומיין יכולים לגשת אליו, והם יכולים לשנות אותו או להעביר אותו למצבים ACTIVE או DECLINED. אפשר לשנות קורס ל-PROVISIONED רק אם הוא במצב DECLINED.
DECLINED הקורס נוצר, אבל נדחה. הבעלים של הקורס והאדמינים בדומיין יכולים לגשת אליו, אבל הוא לא יוצג בממשק המשתמש באינטרנט. אי אפשר לשנות את הקורס, חוץ מאשר להעביר אותו למצב PROVISIONED. אפשר לשנות קורס ל-DECLINED רק אם הוא במצב PROVISIONED.
SUSPENDED הקורס הושעה. אי אפשר לשנות את הקורס, ורק המשתמש שזוהה באמצעות ownerId יכול לראות את הקורס. קורס יכול להיות במצב הזה אם הוא עלול להפר את התנאים וההגבלות.

CourseMaterialSet

קבוצה של חומרים שמופיעה בדף "מידע כללי" של הקורס. החומרים האלה יכולים לכלול סילבוס, לוח זמנים או מידע רקע אחר שקשור לקורס כולו.

ייצוג ב-JSON 
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
שדות
title

string

השם של הקבוצה הזו.
materials[]

object (CourseMaterial)

חומרים שמצורפים לערכה הזו.

CourseMaterial

חומר לימוד שמצורף לקורס כחלק מקבוצת חומרי לימוד.

ייצוג ב-JSON 
{

  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
}
שדות
נתוני חומרים. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
driveFile

object (DriveFile)

קובץ מצורף מ-Google Drive.
youTubeVideo

object (YouTubeVideo)

סרטון ב-YouTube מצורף.
form

object (Form)

קובץ מצורף מ-Google Forms.
סוף השדות שמוציאים זה את זה.

GradebookSettings

ההגדרות של גיליון הציונים בקורס. פרטים נוספים זמינים במאמר הזה במרכז העזרה.

ייצוג ב-JSON 
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
שדות
calculationType

enum (CalculationType)

מציין איך הציון הכולל מחושב.
displaySetting

enum (DisplaySetting)

מציין מי יכול לראות את הציון הכולל.
gradeCategories[]

object (GradeCategory)

קטגוריות הציונים שזמינות לעבודות בקורס.

CalculationType

שיטות אפשריות לחישוב הציון הכולל.

טיפוסים בני מנייה (enum)
CALCULATION_TYPE_UNSPECIFIED לא צוינה שיטה. הערך הזה אף פעם לא מוחזר.
TOTAL_POINTS הציון הכולל הוא סכום הציונים חלקי סכום הנקודות הכולל, בלי קשר לקטגוריה.
WEIGHTED_CATEGORIES הציון הכולל הוא הממוצע המשוקלל לפי קטגוריה.

DisplaySetting

הגדרות אפשריות להצגת הציון הכולל.

טיפוסים בני מנייה (enum)
DISPLAY_SETTING_UNSPECIFIED לא צוינה הגדרה. הערך הזה אף פעם לא מוחזר.
SHOW_OVERALL_GRADE הציון הכולל מוצג למורים ולתלמידים בגיליון הציונים ובפרופיל התלמיד/ה.
HIDE_OVERALL_GRADE הציון הכולל לא מוצג בגיליון הציונים או בפרופיל של התלמיד/ה.
SHOW_TEACHERS_ONLY הציון הכולל מוצג למורים בגיליון הציונים ובפרופיל של התלמיד/ה. ההערה מוסתרת מהתלמידים בפרופיל שלהם.

CourseLearningStandardSettings

הגדרות הדרישות הלימודיות בקורס.

ייצוג ב-JSON 
{
  "standardSets": [
    {
      object (LearningStandardSetRoot)
    }
  ]
}
שדות
standardSets[]

object (LearningStandardSetRoot)

חובה. קבוצת השורשים של הדרישות הלימודיות שחלות על הקורס הזה.

LearningStandardSetRoot

מייצג את הבסיס של קבוצה נבחרת של דרישות לימודיות. הצאצאים של השורשים שנבחרו יוצגו כשמגדירים יעדי למידה בפריטים ב-Stream בממשק המשתמש של Classroom.

ייצוג ב-JSON 
{
  "caseGuid": {
    object (CaseGuid)
  },
  "documentTitle": string,
  "standardTitle": string,
  "sourceDataAvailabilityStatus": enum (LearningStandardAvailabilityState)
}
שדות
caseGuid

object (CaseGuid)

חובה. ‫ה-GUID של Satchel Rosetta Exchange לשורש של קבוצת דרישות לימודיות.
documentTitle

string

פלט בלבד. שם המסמך של קבוצת דרישות לימודיות ברמה הבסיסית.
standardTitle

string

פלט בלבד. השם של קבוצת דרישות לימודיות ברמה הבסיסית (root).
sourceDataAvailabilityStatus

enum (LearningStandardAvailabilityState)

פלט בלבד. סטטוס הזמינות של קבוצת מדדי ההערכה. אפשר להשתמש בזה כדי לקבוע אם השורש של קבוצת דרישות הלימוד נמחק מהמקור.

Methods

checkAddOnCreationEligibility
(deprecated)

 הפונקציה מחזירה ערך שמציין אם למשתמש יש הרשאה ליצור קבצים מצורפים של תוספים בקורס נתון.

checkGradingPeriodsSetupEligibility
(deprecated)

 הפונקציה מחזירה ערך שמציין אם המשתמש יכול לעדכן את GradingPeriodSettings בקורס נתון.

create

 יוצרת קורס.

delete

 מחיקת קורס.

get

 מחזירה קורס.

getGradingPeriodSettings

 מחזירה את ההגדרות של התקופה למתן ציונים בקורס.

list

 הפונקציה מחזירה רשימה של קורסים שהמשתמש ששלח את הבקשה רשאי לראות, ומוגבלת לקורסים שתואמים לבקשה.

patch

 עדכון של שדה אחד או יותר בקורס.

update

 עדכון קורס.

updateGradingPeriodSettings

 מעדכן את ההגדרות של תקופת מתן הציונים בקורס.