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)
  }
}
שדות
id

string

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

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

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

string

שם הקורס. לדוגמה, 'ביולוגיה כיתה י'. חובה להזין שם. המחרוזת צריכה להיות באורך של 1 עד 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)

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

קריאה בלבד.

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

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

קריאה בלבד.

חותמת זמן בפורמט 'Zulu' בפורמט RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
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)

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

קריאה בלבד

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 
{

  // Union field material can be only one of the following:
  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
  // End of list of possible types for union field material.
}
שדות
שדה האיחוד material. נתונים מהותיים. material יכול להיות רק אחת מהאפשרויות הבאות:
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 הציון הכולל מוצג למורים בגיליון הציונים ובפרופיל התלמיד/ה. התלמידים לא יוכלו לראות את המידע הזה בפרופיל שלהם.

שיטות

checkAddOnCreationEligibility
(deprecated)

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

checkGradingPeriodsSetupEligibility
(deprecated)

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

create

 יצירת קורס.

delete

 מוחקים קורס.

get

 הפונקציה מחזירה קורס.

getGradingPeriodSettings

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

list

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

patch

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

update

 עדכון קורס.

updateGradingPeriodSettings

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