Method: courses.list

요청 사용자가 볼 수 있는 과정 목록을 반환하며 요청과 일치하는 과정으로 제한됩니다. 반환된 과정은 생성 시간을 기준으로 정렬되며 가장 최근에 생성된 과정이 먼저 표시됩니다.

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

  • PERMISSION_DENIED 액세스 오류의 경우
  • 쿼리 인수의 형식이 잘못된 경우 INVALID_ARGUMENT
  • 쿼리 인수에 지정된 사용자가 없는 경우 NOT_FOUND

HTTP 요청

GET https://classroom.googleapis.com/v1/courses

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

쿼리 매개변수

매개변수
studentId

string

반환된 과정을 지정된 식별자가 있는 학생이 있는 과정으로 제한합니다. 식별자는 다음 중 하나일 수 있습니다.

  • 사용자의 숫자 식별자
  • 사용자의 이메일 주소
  • 요청 사용자를 나타내는 문자열 리터럴 "me"

지정된 경우 teacherId는 비어 있어야 합니다.
teacherId

string

반환된 과정을 지정된 식별자가 있는 교사가 있는 과정으로 제한합니다. 식별자는 다음 중 하나일 수 있습니다.

  • 사용자의 숫자 식별자
  • 사용자의 이메일 주소
  • 요청 사용자를 나타내는 문자열 리터럴 "me"

지정된 경우 studentId는 비어 있어야 합니다.
courseStates[]

enum (CourseState)

반환된 과정을 지정된 상태 중 하나에 있는 과정으로 제한합니다. 기본값은 ACTIVE, ARCHIVED, PROVISIONED, DECLINED입니다.
pageSize

integer

반환할 최대 항목 수입니다. 0 또는 지정되지 않은 경우 서버에서 최댓값을 할당할 수 있음을 나타냅니다.

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

string

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

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

요청 본문

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

응답 본문

과정 목록을 표시할 때의 응답입니다.

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

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

object (Course)

목록 요청과 일치하는 과정입니다.
nextPageToken

string

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

승인 범위

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

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

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