REST Resource: registrations

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 đến được cung cấp.

Biểu diễn dưới dạng JSON 
{
  "registrationId": string,
  "feed": {
    object (Feed)
  },
  "expiryTime": string,

  // Union field destination can be only one of the following:
  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
  // End of list of possible types for union field destination.
}
Trường
registrationId

string

Giá trị nhận dạng duy nhất do máy chủ tạo cho Registration này.

Chỉ đọc.
feed

object (Feed)

Quy cách cho loại thông báo mà Lớp học sẽ gửi đến đích đến.
expiryTime

string (Timestamp format)

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

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

Sử dụng RFC 3339, trong đó đầ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 độ 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".
Trường nhóm destination. Nơi gửi thông báo. destination chỉ có thể là một trong những trạng thái sau:
cloudPubsubTopic

object (CloudPubsubTopic)

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ả các thay đổi về danh sách cho một miền".

Biểu diễn dưới dạng JSON 
{
  "feedType": enum (FeedType),

  // Union field info can be only one of the following:
  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
  // End of list of possible types for union field info.
}
Trường
feedType

enum (FeedType)

Loại nguồn cấp dữ liệu.
Trường nhóm 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 trạng thái sau:
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.

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ả cá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 một khoá học.

Hệ thống sẽ không tạo thông báo khi lời mời được tạo hoặc xoá, như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ả các thay đổi về danh sách cho 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 một khoá học.

Hệ thống sẽ không tạo thông báo khi lời mời được tạo hoặc xoá, như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 liên quan đến bài tập trên lớp của một khoá học cụ thể.

Thông báo sẽ được tạo khi đố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ẹ của đối tượng đó (nhưng sẽ có thông báo đượ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 trong 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 mà bạn muốn đă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 một Chủ đề trên 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 đã cung cấp đến đích được cung cấp trong cloudPubSubTopic.

delete

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