Method: courses.announcements.list

Trả về danh sách thông báo mà người yêu cầu được phép xem.

Học viên của khoá học chỉ có thể xem thông báo PUBLISHED. Giáo viên khoá học và quản trị viên miền có thể xem tất cả thông báo.

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 do lỗi truy cập.
  • INVALID_ARGUMENT nếu yêu cầu không đúng định dạng.
  • 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}/announcements

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 alias.

Tham số truy vấn

Thông số
announcementStates[]

enum (AnnouncementState)

Hạn chế về state của thông báo được trả về. Nếu bạn không chỉ định đối số này, giá trị mặc định sẽ là PUBLISHED.
orderBy

string

Thứ tự sắp xếp kết quả (không bắt buộc). Danh sách các trường được phân tách bằng dấu phẩy, trong đó 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á hướng được hỗ trợ là asc và desc. Nếu không được chỉ định, updateTime desc sẽ 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 hơn số kết quả đượ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 đã tạo ra mã thông báo này.

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

Nội dung phản hồi khi bạn đăng bài tập trong khoá học.

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 
{
  "announcements": [
    {
      object (Announcement)
    }
  ],
  "nextPageToken": string
}
Trường
announcements[]

object (Announcement)

Các mục thông báo khớ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, bạn sẽ không nhận đượ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.announcements
  • https://www.googleapis.com/auth/classroom.announcements.readonly

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