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,
  "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

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

string

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

אפשר לנקות את השדה הזה רק באמצעות ה-method‏ 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)
  }
}
שדות
שדה איחוד 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 הצגת הציון הכולל למורים בגיליון הציונים ובפרופיל התלמיד. ההסתרות מתבצעות בפרופיל התלמיד.

Methods

checkAddOnCreationEligibility
(deprecated)

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

checkGradingPeriodsSetupEligibility
(deprecated)

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

create

 יוצר קורס.

delete

 מחיקת קורס.

get

 מחזירה קורס.

getGradingPeriodSettings

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

list

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

patch

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

update

 עדכון קורס.

updateGradingPeriodSettings

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