REST Resource: courses

리소스: 과정

클래스룸의 과정

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

클래스룸에서 할당한 이 과정의 식별자입니다.

creating a course인 경우 요청에서 이 식별자를 alias string로 설정하여 상응하는 별칭을 만들 수 있습니다. id는 여전히 클래스룸에서 할당하며 과정을 만든 후에는 업데이트할 수 없습니다.

과정 업데이트 마스크에 이 필드를 지정하면 오류가 발생합니다.
name

string

과정의 이름입니다. 예: '10학년 생물' 이름은 필수 항목입니다. 1~750자(영문 기준) 사이여야 하며 유효한 UTF-8 문자열이어야 합니다.
section

string

과정의 섹션입니다. 예: '2학기' 이 필드는 설정된 경우 유효한 UTF-8 문자열이어야 하며 2, 800자(영문 기준) 이하여야 합니다.
descriptionHeading

string

설명의 제목(선택사항)입니다. 예: '10학년 생물학에 오신 것을 환영합니다.' 이 필드는 설정된 경우 유효한 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' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
updateTime

string (Timestamp format)

이 과정이 마지막으로 업데이트된 시간입니다. 과정 업데이트 마스크에 이 필드를 지정하면 오류가 발생합니다.

읽기 전용입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "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

모든 과정 구성원이 볼 수 있는 캘린더의 캘린더 ID로, 클래스룸에서 과정의 과정 과제 및 공지사항 일정을 추가합니다.

과정의 Calendar는 과정이 처음으로 CourseState.ACTIVE로 설정될 때 (생성 시 또는 UI 또는 API를 통해 ACTIVE로 업데이트될 때) 비동기식으로 생성됩니다. 생성 프로세스가 완료될 때까지 Calendar ID가 채워지지 않습니다.

읽기 전용입니다.
gradebookSettings

object (GradebookSettings)

학생의 과정 전체 성적을 계산하는 방법과 성적을 표시할 대상을 지정하는 성적부 설정입니다.

읽기 전용

CourseState

강의가 있을 수 있는 상태입니다.

열거형
COURSE_STATE_UNSPECIFIED 과정 상태가 없습니다. 반환된 과정 메시지에서 이 값을 사용하지 않습니다.
ACTIVE 과정이 활성 상태입니다.
ARCHIVED 과정이 보관처리되었습니다. 다른 상태로 변경하는 것 외에는 수정할 수 없습니다.
PROVISIONED 과정이 생성되었지만 아직 활성화되지 않았습니다. 담당 교사와 도메인 관리자가 액세스할 수 있으며, 담당 교사와 도메인 관리자는 이 옵션을 수정하거나 ACTIVE 또는 DECLINED 상태로 변경할 수 있습니다. 과정은 DECLINED 상태에 있는 경우에만 PROVISIONED로 변경할 수 있습니다.
DECLINED 과정이 생성되었지만 거부되었습니다. 웹 UI에는 표시되지 않지만 과정 소유자와 도메인 관리자가 액세스할 수 있습니다. 과정을 PROVISIONED 상태로 변경하는 것 외에는 수정할 수 없습니다. 과정은 PROVISIONED 상태에 있는 경우에만 DECLINED로 변경할 수 있습니다.
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

전체 성적을 계산하는 데 사용할 수 있는 방법입니다.

열거형
CALCULATION_TYPE_UNSPECIFIED 지정된 메서드가 없습니다. 이 값은 반환되지 않습니다.
TOTAL_POINTS 전체 성적은 카테고리와 관계없이 성적의 합계를 총점의 합계로 나눈 값입니다.
WEIGHTED_CATEGORIES 전체 성적은 카테고리별 가중 평균입니다.

DisplaySetting

전체 성적을 표시할 수 있는 설정입니다.

열거형
DISPLAY_SETTING_UNSPECIFIED 지정된 설정이 없습니다. 이 값은 반환되지 않습니다.
SHOW_OVERALL_GRADE 성적부 및 학생 프로필에서 교사와 학생 모두에게 전체 성적을 표시합니다.
HIDE_OVERALL_GRADE 성적 기록 또는 학생 프로필에 전체 성적이 표시되지 않습니다.
SHOW_TEACHERS_ONLY 성적부 및 학생 프로필에서 교사에게 전체 성적을 표시합니다. 학생 프로필에서 학생에게 표시되지 않습니다.

메서드

checkAddOnCreationEligibility
(deprecated)

 사용자가 지정된 과정에서 부가기능 첨부파일을 만들 수 있는지 여부를 반환합니다.

checkGradingPeriodsSetupEligibility
(deprecated)

 사용자가 특정 과정의 GradingPeriodSettings를 업데이트할 수 있는지 여부를 반환합니다.

create

 강의를 만듭니다.

delete

 강의를 삭제합니다.

get

 과정을 반환합니다.

getGradingPeriodSettings

 과정의 평가 기간 설정을 반환합니다.

list

 요청하는 사용자가 볼 수 있는 과정 목록을 반환하며, 요청과 일치하는 과정으로 제한됩니다.

patch

 과정의 하나 이상의 필드를 업데이트합니다.

update

 과정을 업데이트합니다.

updateGradingPeriodSettings

 과정의 평가 기간 설정을 업데이트합니다.