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 đã 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ó thể đọc.

feed

object (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.

expiryTime

string (Timestamp format)

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

Đâ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ụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

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:
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ả 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 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:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

Thông tin về FeedfeedTypeCOURSE_ROSTER_CHANGES. Bạn phải chỉ định trường này nếu feedTypeCOURSE_ROSTER_CHANGES.

courseWorkChangesInfo

object (CourseWorkChangesInfo)

Thông tin về FeedfeedTypeCOURSE_WORK_CHANGES. Bạn phải chỉ định trường này nếu feedTypeCOURSE_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ả 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ề FeedfeedTypeCOURSE_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 lớp học.

CourseWorkChangesInfo

Thông tin về FeedfeedTypeCOURSE_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 công việc.

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ủ đề 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 đến đượ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 đó.