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 חוקית ולא יותר מ-2800 תווים.
descriptionHeading

string

כותרת אופציונלית לתיאור. לדוגמה, "ברוכים הבאים לביולוגיה בכיתה י'". אם השדה הזה מוגדר, השדה הזה חייב להיות מחרוזת UTF-8 חוקית באורך של עד 3600 תווים.
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, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

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

קריאה בלבד.

חותמת זמן בפורמט "זולו" 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

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

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

קריאה בלבד.
gradebookSettings

object (GradebookSettings)

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

קריאה-בלבד

CourseState

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

טיפוסים בני מנייה (enums)
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

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

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

DisplaySetting

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

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

שיטות

checkAddOnCreationEligibility

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

create

 יצירת קורס.

delete

 מוחק קורס.

get

 מחזירה קורס.

list

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

patch

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

update

 עדכון קורס.