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