Method: courses.courseWorkMaterials.list

요청자가 볼 수 있는 수업 자료 목록을 반환합니다.

강의 학생은 PUBLISHED 강의 과제 자료만 볼 수 있습니다. 강의 교사와 도메인 관리자는 모든 강의 자료를 볼 수 있습니다.

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

  • 요청한 사용자가 요청된 과정에 액세스할 수 없는 경우 또는 액세스 오류의 경우 PERMISSION_DENIED
  • 요청의 형식이 잘못된 경우 INVALID_ARGUMENT
  • 요청된 과정이 없는 경우 NOT_FOUND

HTTP 요청

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

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

경로 매개변수

매개변수
courseId

string

수업의 식별자입니다. 이 식별자는 클래스룸 할당 식별자 또는 alias일 수 있습니다.

쿼리 매개변수

매개변수
courseWorkMaterialStates[]

enum (CourseWorkMaterialState)

반환할 작업 상태에 대한 제한입니다. 일치하는 수업 자료만 반환됩니다. 지정하지 않으면 작업 상태가 PUBLISHED인 항목이 반환됩니다.
orderBy

string

결과의 선택적 정렬 순서입니다. 선택적 정렬 방향 키워드가 포함된 쉼표로 구분된 필드 목록입니다. 지원되는 필드는 updateTime입니다. 지원되는 방향 키워드는 asc 및 desc입니다. 지정되지 않은 경우 updateTime desc이 기본 동작입니다. 예: updateTime asc, updateTime
pageSize

integer

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

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

string

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

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

string

ID가 제공된 문자열과 일치하는 Drive 자료가 하나 이상 있는 수업 자료에 대한 선택적 필터링입니다. materialLink도 지정된 경우 수업 자료에는 두 필터와 모두 일치하는 자료가 있어야 합니다.
previewVersion

enum (PreviewVersion)

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

요청 본문

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

응답 본문

수업 자료를 나열할 때의 응답입니다.

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

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

object (CourseWorkMaterial)

요청과 일치하는 수업 자료 항목입니다.
nextPageToken

string

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

승인 범위

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

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

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