Method: courses.students.list

요청자가 볼 수 있는 이 과정의 학생 목록을 반환합니다.

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

  • 과정이 없는 경우 NOT_FOUND입니다.
  • 액세스 오류: PERMISSION_DENIED

HTTP 요청

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

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

경로 매개변수

매개변수
courseId

string

과정의 식별자입니다. 이 식별자는 클래스룸에서 할당한 식별자 또는 alias일 수 있습니다.

쿼리 매개변수

매개변수
pageSize

integer

반환할 최대 항목 수입니다. 기본값은 지정되지 않은 경우 30이고, 0입니다.

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

string

이전 list 호출에서 반환된 nextPageToken 값이며, 결과의 후속 페이지를 반환해야 함을 나타냅니다.

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

요청 본문

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

응답 본문

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

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

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

object (Student)

목록 요청과 일치하는 학생
nextPageToken

string

반환할 다음 결과 페이지를 식별하는 토큰입니다. 비어 있으면 추가 결과가 없습니다.

승인 범위

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

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

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