REST Resource: courses.announcements

Tài nguyên: Thông báo

Giáo viên tạo thông báo cho học viên của khoá học

Biểu diễn dưới dạng JSON
{
  "courseId": string,
  "id": string,
  "text": string,
  "materials": [
    {
      object (Material)
    }
  ],
  "state": enum (AnnouncementState),
  "alternateLink": string,
  "creationTime": string,
  "updateTime": string,
  "scheduledTime": string,
  "assigneeMode": enum (AssigneeMode),
  "individualStudentsOptions": {
    object (IndividualStudentsOptions)
  },
  "creatorUserId": string
}
Các trường
courseId

string

Giá trị nhận dạng của khoá học.

Chỉ đọc.

id

string

Mã nhận dạng do Lớp học chỉ định của thông báo này, dành riêng cho mỗi khoá học.

Chỉ đọc.

text

string

Nội dung mô tả về thông báo này. Văn bản phải là một chuỗi UTF-8 hợp lệ chứa không quá 30.000 ký tự.

materials[]

object (Material)

Tài liệu bổ sung.

Thông báo không được có quá 20 mục quan trọng.

state

enum (AnnouncementState)

Trạng thái của thông báo này. Nếu không chỉ định, trạng thái mặc định sẽ là DRAFT.

creationTime

string (Timestamp format)

Dấu thời gian khi thông báo này được tạo.

Chỉ đọc.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Dấu thời gian của thay đổi gần đây nhất đối với thông báo này.

Chỉ đọc.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

scheduledTime

string (Timestamp format)

Dấu thời gian không bắt buộc khi thông báo này được lên lịch phát hành.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

assigneeMode

enum (AssigneeMode)

Chế độ người được giao của thông báo. Nếu không chỉ định, giá trị mặc định sẽ là ALL_STUDENTS.

individualStudentsOptions

object (IndividualStudentsOptions)

Giá trị nhận dạng của những học viên có quyền truy cập vào thông báo. Trường này chỉ được đặt nếu assigneeModeINDIVIDUAL_STUDENTS. Nếu assigneeModeINDIVIDUAL_STUDENTS, thì chỉ những học viên được chỉ định trong trường này mới có thể thấy thông báo.

creatorUserId

string

Giá trị nhận dạng của người dùng đã tạo thông báo.

Chỉ đọc.

AnnouncementState

Các trạng thái có thể có của thông báo

Enum
ANNOUNCEMENT_STATE_UNSPECIFIED Chưa chỉ định tiểu bang nào. Hệ thống sẽ không bao giờ trả về dữ liệu này.
PUBLISHED Trạng thái của thông báo đã được xuất bản. Đây là trạng thái mặc định.
DRAFT Trạng thái của một thông báo chưa được xuất bản. Chỉ giáo viên của khoá học và quản trị viên miền mới thấy thông báo ở trạng thái này.
DELETED Trạng thái của thông báo đã xuất bản nhưng hiện đã bị xoá. Chỉ giáo viên của khoá học và quản trị viên miền mới thấy thông báo ở trạng thái này. Thông báo ở trạng thái này sẽ bị xoá sau một khoảng thời gian.

Phương thức

create

Tạo thông báo.

delete

Xoá thông báo.

get

Trả về một thông báo.

getAddOnContext

Lấy siêu dữ liệu cho các tiện ích bổ sung của Lớp học trong bối cảnh của một bài đăng cụ thể.

list

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

modifyAssignees

Sửa đổi chế độ người được giao và các tuỳ chọn của một thông báo.

patch

Cập nhật một hoặc nhiều trường của một thông báo.