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 đến đã 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

Một 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 đến.
expiryTime

string (Timestamp format)

Khoảng thời gian cho đến khi Registration có hiệu lực.

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

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
Trường kết hợp destination. Địa chỉ gửi thông báo. destination chỉ có thể là một trong những trạng thái sau đây:
cloudPubsubTopic

object (CloudPubsubTopic)

Chủ đề Cloud Pub/Sub nơi thông báo sẽ được gửi đến.

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 trong 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 kết hợp 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 đây:
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

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 Tuyệt đối không được trả lại hoặc cung cấp.
DOMAIN_ROSTER_CHANGES

Tất cả thay đổi trong 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 lời mời được tạo hoặc bị xoá, nhưng hệ thố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ề đội hình 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 lời mời được tạo hoặc bị xoá, nhưng hệ thố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 làm bài tập trong một khoá học cụ thể.

Hệ thống sẽ tạo thông báo khi tạo hoặc sửa đổi đối tượng Bài tập môn học hoặc Bài tập của học viên. Hệ thống sẽ không tạo thông báo khi một đối tượng Bài tập của học viên được tạo liên quan đến việc tạo hoặc sửa đổi đối tượng CourseWork gốc (nhưng hệ thống sẽ tạo thông báo khi 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ý vào danh sách sẽ thay đổi.

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ý làm bài tập sẽ thay đổi.

CloudPubsubTopic

Tài liệu tham khảo về một chủ đề trên Cloud Pub/Sub.

Để đăng ký nhận thông báo, chủ sở hữu 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
}
Trường
topicName

string

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

Phương thức

create

 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.

delete

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