Google Classroom API

Google 클래스룸에서 수업, 출석부, 초대를 관리합니다.

서비스: classroom.googleapis.com

이 서비스를 호출하려면 Google에서 제공하는 클라이언트 라이브러리를 사용하는 것이 좋습니다. 애플리케이션에서 자체 라이브러리를 사용하여 이 서비스를 호출해야 한다면 API 요청을 실행할 때 다음 정보를 사용해야 합니다.

검색 문서

검색 문서는 머신에서 읽을 수 있는 사양이며 REST API를 설명하고 사용하는 데 참조할 수 있습니다. 또한 클라이언트 라이브러리, IDE 플러그인, 기타 Google API와 상호작용하는 도구를 빌드하는 데 사용됩니다. 하나의 서비스는 여러 개의 검색 문서를 제공할 수 있습니다. 이 서비스는 다음 검색 문서를 제공합니다.

서비스 엔드포인트

서비스 엔드포인트는 API 서비스의 네트워크 주소를 지정하는 기준 URL입니다. 하나의 서비스는 여러 서비스 엔드포인트를 포함할 수 있습니다. 이 서비스에는 다음 서비스 엔드포인트가 포함되고, 그 아래의 모든 URI가 이 서비스 엔드포인트와 관련됩니다.

  • https://classroom.googleapis.com

REST 리소스: v1.courses

메서드
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
사용자가 지정된 과정에서 부가기능 첨부파일을 만들 수 있는지 여부를 반환합니다.
checkGradingPeriodsSetupEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
사용자가 특정 과정의 GradingPeriodSettings를 업데이트할 수 있는지 여부를 반환합니다.
create POST /v1/courses
강의를 만듭니다.
delete DELETE /v1/courses/{id}
강의를 삭제합니다.
get GET /v1/courses/{id}
과정을 반환합니다.
getGradingPeriodSettings GET /v1/courses/{courseId}/gradingPeriodSettings
과정의 평가 기간 설정을 반환합니다.
list GET /v1/courses
요청한 사용자가 볼 수 있고 요청과 일치하는 과정으로 제한된 과정 목록을 반환합니다.
patch PATCH /v1/courses/{id}
과정의 하나 이상의 필드를 업데이트합니다.
update PUT /v1/courses/{id}
강의를 업데이트합니다.
updateGradingPeriodSettings PATCH /v1/courses/{courseId}/gradingPeriodSettings
강의의 평가 기간 설정을 업데이트합니다.

REST 리소스: v1.courses.aliases

메서드
create POST /v1/courses/{courseId}/aliases
강의의 별칭을 만듭니다.
delete DELETE /v1/courses/{courseId}/aliases/{alias}
강의의 별칭을 삭제합니다.
list GET /v1/courses/{courseId}/aliases
과정의 별칭 목록을 반환합니다.

REST 리소스: v1.courses.announcements

메서드
create POST /v1/courses/{courseId}/announcements
공지사항을 만듭니다.
delete DELETE /v1/courses/{courseId}/announcements/{id}
공지사항을 삭제합니다.
get GET /v1/courses/{courseId}/announcements/{id}
공지사항을 반환합니다.
getAddOnContext GET /v1/courses/{courseId}/announcements/{itemId}/addOnContext
특정 게시물의 컨텍스트에서 클래스룸 부가기능의 메타데이터를 가져옵니다.
list GET /v1/courses/{courseId}/announcements
요청자가 볼 수 있는 공지사항 목록을 반환합니다.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
공지사항의 담당자 모드 및 옵션을 수정합니다.
patch PATCH /v1/courses/{courseId}/announcements/{id}
공지사항에서 하나 이상의 필드를 업데이트합니다.

REST 리소스: v1.courses.announcements.addOnAttachments

메서드
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
게시물 아래에 부가기능 첨부파일을 만듭니다.
delete DELETE /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
부가기능 첨부파일을 삭제합니다.
get GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
부가기능 첨부파일을 반환합니다.
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
게시물에서 부가기능으로 만든 모든 첨부파일을 반환합니다.
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
부가기능 첨부파일을 업데이트합니다.

REST 리소스: v1.courses.courseWork

메서드
create POST /v1/courses/{courseId}/courseWork
수업 과제를 만듭니다.
delete DELETE /v1/courses/{courseId}/courseWork/{id}
수업 과제를 삭제합니다.
get GET /v1/courses/{courseId}/courseWork/{id}
과정 과제를 반환합니다.
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
특정 게시물의 맥락에서 클래스룸 부가기능의 메타데이터를 가져옵니다.
list GET /v1/courses/{courseId}/courseWork
요청자가 볼 수 있는 수업 과제 목록을 반환합니다.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
할당된 사용자 모드 및 수업 과제 옵션을 수정합니다.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
과정 작업의 필드 하나 이상을 업데이트합니다.

REST 리소스: v1.courses.courseWork.addOnAttachments

메서드
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
게시물 아래에 부가기능 첨부파일을 만듭니다.
delete DELETE /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
부가기능 첨부파일을 삭제합니다.
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
부가기능 첨부파일을 반환합니다.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
게시물에서 부가기능으로 만든 모든 첨부파일을 반환합니다.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
부가기능 첨부파일을 업데이트합니다.

REST 리소스: v1.courses.courseWork.addOnAttachments.studentSubmissions

메서드
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
부가기능 첨부파일의 학생 제출물을 반환합니다.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
부가기능 첨부파일 제출과 관련된 데이터를 업데이트합니다.

REST 리소스: v1.courses.courseWork.rubrics

메서드
create POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
기준표를 만듭니다.
delete DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
기준표를 삭제합니다.
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
기준표를 반환합니다.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
요청자가 볼 수 있는 기준표 목록을 반환합니다.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
기준표를 업데이트합니다.

REST 리소스: v1.courses.courseWork.studentSubmissions

메서드
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
학생 제출물을 반환합니다.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
요청자의 OAuth 범위를 고려하여 요청자가 볼 수 있는 학생 제출물 목록을 반환합니다.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
학생 제출물의 첨부파일을 수정합니다.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
학생 제출물의 하나 이상의 필드를 업데이트합니다.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
소유한 학생을 대신하여 학생 제출물을 회수합니다.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
학생 제출물을 반환합니다.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
학생 제출물을 제출합니다.

REST 리소스: v1.courses.courseWorkMaterials

메서드
create POST /v1/courses/{courseId}/courseWorkMaterials
강의 과제 자료를 만듭니다.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
과정 자료 삭제
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
과정 과제 자료를 반환합니다.
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
특정 게시물의 컨텍스트에서 클래스룸 부가기능의 메타데이터를 가져옵니다.
list GET /v1/courses/{courseId}/courseWorkMaterials
요청자가 볼 수 있는 과정 과제 자료 목록을 반환합니다.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
수업 과제 자료의 필드를 하나 이상 업데이트합니다.

REST 리소스: v1.courses.courseWorkMaterials.addOnAttachments

메서드
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
게시물 아래에 부가기능 첨부파일을 만듭니다.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
부가기능 첨부파일을 삭제합니다.
get GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
부가기능 첨부파일을 반환합니다.
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
게시물에서 부가기능으로 만든 모든 첨부파일을 반환합니다.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
부가기능 첨부파일을 업데이트합니다.

REST 리소스: v1.courses.posts

메서드
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
특정 게시물의 맥락에서 클래스룸 부가기능의 메타데이터를 가져옵니다.

REST 리소스: v1.courses.posts.addOnAttachments

메서드
create POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments
게시물 아래에 부가기능 첨부파일을 만듭니다.
delete DELETE /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
부가기능 첨부파일을 삭제합니다.
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
부가기능 첨부파일을 반환합니다.
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
게시물 아래 부가기능에서 생성한 모든 첨부파일을 반환합니다.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
부가기능 첨부파일을 업데이트합니다.

REST 리소스: v1.courses.posts.addOnAttachments.studentSubmissions

메서드
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
부가기능 첨부파일의 학생 제출물을 반환합니다.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
부가기능 첨부파일 제출과 관련된 데이터를 업데이트합니다.

REST 리소스: v1.courses.students

메서드
create POST /v1/courses/{courseId}/students
사용자를 강의의 학생으로 추가합니다.
delete DELETE /v1/courses/{courseId}/students/{userId}
강의의 학생을 삭제합니다.
get GET /v1/courses/{courseId}/students/{userId}
과정의 학생을 반환합니다.
list GET /v1/courses/{courseId}/students
요청자가 볼 수 있는 이 과정의 학생 목록을 반환합니다.

REST 리소스: v1.courses.teachers

메서드
create POST /v1/courses/{courseId}/teachers
과정의 교사를 만듭니다.
delete DELETE /v1/courses/{courseId}/teachers/{userId}
지정된 과정에서 지정된 교사를 삭제합니다.
get GET /v1/courses/{courseId}/teachers/{userId}
강의의 교사를 반환합니다.
list GET /v1/courses/{courseId}/teachers
요청자가 볼 수 있는 이 과정의 교사 목록을 반환합니다.

REST 리소스: v1.courses.topics

메서드
create POST /v1/courses/{courseId}/topics
주제를 만듭니다.
delete DELETE /v1/courses/{courseId}/topics/{id}
주제를 삭제합니다.
get GET /v1/courses/{courseId}/topics/{id}
주제를 반환합니다.
list GET /v1/courses/{courseId}/topics
요청자가 볼 수 있는 주제 목록을 반환합니다.
patch PATCH /v1/courses/{courseId}/topics/{id}
주제의 필드 하나 이상을 업데이트합니다.

REST 리소스: v1.invitations

메서드
accept POST /v1/invitations/{id}:accept
초대를 수락하고 삭제한 후 초대된 사용자를 지정된 과정의 교사 또는 학생 (해당하는 경우)에 추가합니다.
create POST /v1/invitations
초대를 만듭니다.
delete DELETE /v1/invitations/{id}
초대를 삭제합니다.
get GET /v1/invitations/{id}
초대를 반환합니다.
list GET /v1/invitations
요청하는 사용자가 볼 수 있는 초대 목록을 반환하며, 목록 요청과 일치하는 초대로 제한됩니다.

REST 리소스: v1.registrations

메서드
create POST /v1/registrations
Registration를 만들어 클래스룸에서 제공된 feed에서 cloudPubSubTopic에 제공된 대상으로 알림을 전송하도록 합니다.
delete DELETE /v1/registrations/{registrationId}
Registration를 삭제하여 클래스룸에서 해당 Registration에 대한 알림을 더 이상 보내지 않도록 합니다.

REST 리소스: v1.userProfiles

메서드
checkUserCapability GET /v1/userProfiles/{userId}:checkUserCapability
사용자가 지정된 클래스룸 기능을 사용할 수 있는지 여부를 반환합니다.
get GET /v1/userProfiles/{userId}
사용자 프로필을 반환합니다.

REST 리소스: v1.userProfiles.guardianInvitations

메서드
create POST /v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
보호자 초대를 만들고 학생의 보호자임을 확인하는 이메일을 보호자에게 보냅니다.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
특정 보호자 초대를 반환합니다.
list GET /v1/userProfiles/{studentId}/guardianInvitations
요청하는 사용자가 볼 수 있는 보호자 초대 목록을 반환하며, 제공된 매개변수로 필터링됩니다.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
보호자 초대를 수정합니다.

REST 리소스: v1.userProfiles.guardians

메서드
delete DELETE /v1/userProfiles/{studentId}/guardians/{guardianId}
보호자를 삭제합니다.
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
특정 보호자를 반환합니다.
list GET /v1/userProfiles/{studentId}/guardians
요청하는 사용자가 볼 수 있는 보호자 목록을 반환하며, 요청과 일치하는 보호자로 제한됩니다.