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)

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

קריאה בלבד.

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

string (Timestamp format)

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

קריאה בלבד.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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 מוסיפה אירועים לעבודות בקורס והודעות לכיתה.

יומן Google עבור קורס נוצר באופן אסינכרוני כאשר הקורס מוגדר כ-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

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

checkGradingPeriodsSetupEligibility

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

create

 יצירת קורס

delete

 מוחקים קורס.

get

 מחזירה קורס.

getGradingPeriodSettings

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

list

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

patch

 מעדכנים שדה אחד או יותר בקורס.

update

 מעדכנים קורס.

updateGradingPeriodSettings

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