Method: courses.studentGroups.list

강의의 그룹 목록을 반환합니다.

이 메서드는 다음 오류 코드를 반환합니다.

  • 강의가 없는 경우 NOT_FOUND

HTTP 요청

GET https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
courseId

string

필수입니다. 수업의 식별자입니다.

쿼리 매개변수

매개변수
pageSize

integer

반환할 최대 항목 수입니다. 0이거나 지정되지 않은 경우 서버에서 최대값을 할당할 수 있습니다. 현재 최대값은 75개 항목으로 설정되어 있습니다.

서버에서 지정된 결과 수보다 적은 결과를 반환할 수 있습니다.
pageToken

string

이전 list 호출에서 반환된 nextPageToken 값으로, 결과의 다음 페이지가 반환되어야 함을 나타냅니다.

list 요청은 이 토큰을 생성한 요청과 동일해야 합니다.
previewVersion

enum (PreviewVersion)

선택사항입니다. API의 미리보기 버전입니다. 프리뷰 프로그램에서 개발자에게 제공되는 새로운 API 기능에 액세스하려면 이 값을 설정해야 합니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

학생 그룹을 나열할 때의 응답입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "studentGroups": [
    {
      object (StudentGroup)
    }
  ],
  "nextPageToken": string
}
필드
studentGroups[]

object (StudentGroup)

학생 그룹입니다.
nextPageToken

string

반환할 결과의 다음 페이지를 식별하는 토큰입니다. 비어 있으면 더 이상 결과를 사용할 수 없습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly

자세한 내용은 승인 가이드를 참고하세요.