- Tài nguyên: Đăng ký
- Nguồn cấp dữ liệu
- FeedType
- CourseRosterChangesInfo
- CourseWorkChangesInfo
- CloudPubsubTopic
- Phương thức
Tài nguyên: Đăng ký
Hướng dẫn cho Lớp học gửi thông báo từ feed
đến điểm đến đã cung cấp.
Biểu diễn dưới dạng JSON |
---|
{ "registrationId": string, "feed": { object ( |
Các trường | |
---|---|
registrationId |
Giá trị nhận dạng duy nhất do máy chủ tạo cho Chỉ đọc. |
feed |
Thông số kỹ thuật của lớp thông báo mà Lớp học sẽ gửi đến đích. |
expiryTime |
Thời gian đến khi Đây là trường chỉ đọc do máy chủ chỉ đị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ụ: |
Trường nhóm destination . Địa chỉ nhận thông báo. destination chỉ có thể là một trong những trạng thái sau đây: |
|
cloudPubsubTopic |
Chủ đề về Cloud Pub/Sub mà bạn muốn gửi thông báo. |
Nguồn cấp dữ liệu
Một loại thông báo mà ứng dụng có thể đăng ký nhận. Ví dụ: "tất cả thay đổi về danh sách cho một miền".
Biểu diễn dưới dạng JSON |
---|
{ "feedType": enum ( |
Các trường | |
---|---|
feedType |
Loại nguồn cấp dữ liệu. |
Trường nhóm info . Các thông số bổ sung về nguồn cấp dữ liệu. info chỉ có thể là một trong những trạng thái sau đây: |
|
courseRosterChangesInfo |
Thông tin về một |
courseWorkChangesInfo |
Thông tin về một |
FeedType
Loại nguồn cấp dữ liệu mà ứng dụng có thể đăng ký nhận thông báo.
Enum | |
---|---|
FEED_TYPE_UNSPECIFIED |
Không được trả lại hoặc cung cấp thông tin này. |
DOMAIN_ROSTER_CHANGES |
Tất cả thay đổi về danh sách cho một miền cụ thể. Hệ thống sẽ tạo thông báo mỗi khi người dùng tham gia hoặc rời khỏi khoá học. Hệ thống sẽ không tạo thông báo khi người dùng tạo hoặc xoá lời mời, nhưng hệ thống sẽ tạo thông báo khi người dùng chấp nhận lời mời tham gia khoá học. |
COURSE_ROSTER_CHANGES |
Tất cả thay đổi về danh sách cho một khoá học cụ thể. Hệ thống sẽ tạo thông báo mỗi khi người dùng tham gia hoặc rời khỏi khoá học. Hệ thống sẽ không tạo thông báo khi người dùng tạo hoặc xoá lời mời, nhưng hệ thống sẽ tạo thông báo khi người dùng chấp nhận lời mời tham gia khoá học. |
COURSE_WORK_CHANGES |
Tất cả hoạt động trong khoá học của một khoá học cụ thể. Hệ thống sẽ tạo thông báo khi bạn tạo hoặc sửa đổi một đối tượng CourseWork hoặc StudentSubmission. Hệ thống sẽ không tạo thông báo khi tạo một đối tượng StudentSubmission liên quan đến việc tạo hoặc sửa đổi đối tượng CourseWork gốc (nhưng sẽ có thông báo về việc tạo hoặc sửa đổi đối tượng CourseWork đó). |
CourseRosterChangesInfo
Thông tin về một Feed
với feedType
là COURSE_ROSTER_CHANGES
.
Biểu diễn dưới dạng JSON |
---|
{ "courseId": string } |
Các trường | |
---|---|
courseId |
|
CourseWorkChangesInfo
Thông tin về một Feed
với feedType
là COURSE_WORK_CHANGES
.
Biểu diễn dưới dạng JSON |
---|
{ "courseId": string } |
Các trường | |
---|---|
courseId |
|
CloudPubsubTopic
Nội dung tham khảo về chủ đề Cloud Pub/Sub.
Để đăng ký nhận thông báo, chủ sở hữu của chủ đề phải cấp quyền projects.topics.publish
cho classroom-notifications@system.gserviceaccount.com
.
Biểu diễn dưới dạng JSON |
---|
{ "topicName": string } |
Các trường | |
---|---|
topicName |
Trường |
Phương thức |
|
---|---|
|
Tạo Registration , khiến Lớp học bắt đầu gửi thông báo từ feed được cung cấp đến đích được cung cấp trong cloudPubSubTopic . |
|
Xoá Registration , khiến Lớp học ngừng gửi thông báo về Registration đó. |