Method: courses.courseWorkMaterials.list

Trả về danh sách tài liệu bài tập mà người yêu cầu được phép xem.

Học viên của khoá học chỉ có thể xem tài liệu PUBLISHED của bài tập trên lớp. Giáo viên khoá học và quản trị viên miền có thể xem tất cả tài liệu bài tập của khoá học.

Phương thức này trả về các mã lỗi sau:

  • PERMISSION_DENIED nếu người dùng yêu cầu không được phép truy cập vào khoá học được yêu cầu hoặc đối với lỗi truy cập.
  • INVALID_ARGUMENT nếu yêu cầu có định dạng không chính xác.
  • NOT_FOUND nếu khoá học được yêu cầu không tồn tại.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
courseId

string

Giá trị nhận dạng của khoá học. Giá trị nhận dạng này có thể là giá trị nhận dạng do Lớp học chỉ định hoặc một alias.

Tham số truy vấn

Thông số
courseWorkMaterialStates[]

enum (CourseWorkMaterialState)

Hạn chế về trạng thái công việc cần trả về. Chỉ những tài liệu bài tập trên lớp phù hợp mới được trả về. Nếu không chỉ định, thì các mục có trạng thái công việc là PUBLISHED sẽ được trả về.
orderBy

string

Thứ tự sắp xếp không bắt buộc cho kết quả. Danh sách các trường được phân tách bằng dấu phẩy có từ khoá hướng sắp xếp không bắt buộc. Trường được hỗ trợ là updateTime. Các từ khoá chỉ đường được hỗ trợ là asc và desc. Nếu bạn không chỉ định, updateTime desc là hành vi mặc định. Ví dụ: updateTime asc, updateTime
pageSize

integer

Số lượng mục tối đa cần trả về. Giá trị 0 hoặc không xác định cho biết máy chủ có thể chỉ định giá trị tối đa.

Máy chủ có thể trả về ít kết quả hơn số lượng được chỉ định.
pageToken

string

Giá trị nextPageToken được trả về từ lệnh gọi list trước đó, cho biết rằng trang kết quả tiếp theo sẽ được trả về.

Yêu cầu list phải giống hệt với yêu cầu dẫn đến mã thông báo này.
materialDriveId

string

Lọc không bắt buộc đối với tài liệu bài tập trên lớp có ít nhất một tài liệu trên Drive có mã nhận dạng khớp với chuỗi được cung cấp. Nếu bạn cũng chỉ định materialLink, thì tài liệu bài tập trên lớp phải có tài liệu khớp với cả hai bộ lọc.
previewVersion

enum (PreviewVersion)

Không bắt buộc. Phiên bản xem trước của API. Bạn phải đặt giá trị này để truy cập vào các chức năng API mới được cung cấp cho nhà phát triển trong Chương trình dùng trước.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Phản hồi khi liệt kê tài liệu bài tập trên lớp.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "courseWorkMaterial": [
    {
      object (CourseWorkMaterial)
    }
  ],
  "nextPageToken": string
}
Trường
courseWorkMaterial[]

object (CourseWorkMaterial)

Các mục tài liệu bài tập trên lớp phù hợp với yêu cầu.
nextPageToken

string

Mã thông báo xác định trang kết quả tiếp theo cần trả về. Nếu trống, tức là không có kết quả nào khác.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.