REST Resource: registrations

Tài nguyên: Đăng ký

Hướng dẫn để 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 (Feed)
  },
  "expiryTime": string,

  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
}
Trường
registrationId

string

Giá trị nhận dạng riêng biệt do máy chủ tạo cho Registration này.

Chỉ có thể đọc.
feed

object (Feed)

Thông số kỹ thuật cho lớp thông báo mà Lớp học sẽ gửi đến đích.
expiryTime

string (Timestamp format)

Thời gian mà Registration có hiệu lực.

Đây là trường chỉ có thể đọc do máy chủ chỉ định.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
Nơi gửi thông báo. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
cloudPubsubTopic

object (CloudPubsubTopic)

Chủ đề Cloud Pub/Sub mà thông báo sẽ được gửi đến.
Kết thúc các trường loại trừ lẫn nhau.

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 (FeedType),

  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
}
Trường
feedType

enum (FeedType)

Loại nguồn cấp dữ liệu.
Các tham số bổ sung về nguồn cấp dữ liệu. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

Thông tin về Feed có feedType là COURSE_ROSTER_CHANGES. Bạn phải chỉ định trường này nếu feedType là COURSE_ROSTER_CHANGES.
courseWorkChangesInfo

object (CourseWorkChangesInfo)

Thông tin về Feed có feedType là COURSE_WORK_CHANGES. Bạn phải chỉ định trường này nếu feedType là COURSE_WORK_CHANGES.
Kết thúc các trường loại trừ lẫn nhau.

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ả lại hoặc cung cấp.
DOMAIN_ROSTER_CHANGES

Tất cả thay đổi về danh sách cho một miền cụ thể.

Thông báo sẽ được tạo bất cứ khi nào 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 bạn tạo hoặc xoá lời mời, nhưng sẽ tạo thông báo khi người dùng tham gia 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 học viên của một khoá học cụ thể.

Thông báo sẽ được tạo bất cứ khi nào 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 bạn tạo hoặc xoá lời mời, nhưng sẽ tạo thông báo khi người dùng tham gia khoá học bằng cách chấp nhận lời mời.
COURSE_WORK_CHANGES

Tất cả hoạt động liên quan đến bài tập trong một khoá học cụ thể.

Thông báo sẽ được tạo khi một đối tượng CourseWork hoặc StudentSubmission được tạo hoặc sửa đổi. Sẽ không có thông báo nào được tạo khi một đố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 thông báo sẽ được tạ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
courseId

string

courseId của khoá học để đăng ký nhận thông báo về các thay đổi đối với danh sách.

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
courseId

string

courseId của khoá học để đăng ký nhận thông báo về các thay đổi đối với bài tập.

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
topicName

string

Trường name của Chủ đề Cloud Pub/Sub.

Phương thức

create

 Tạo một 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.

delete

 Xoá một Registration, khiến Lớp học ngừng gửi thông báo cho Registration đó.