REST Resource: registrations

资源：注册

指示“课堂”如何从“feed”向提供的目标位置发送通知。

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.
}
字段
registrationId

string

服务器为此 Registration 生成的唯一标识符。

只读。
feed

object (Feed)

规范 Google 课堂应发送至目标位置的通知类别。
expiryTime

string (Timestamp format)

Registration 的生效时间。

这是由服务器分配的只读字段。

时间戳，采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式，具有纳秒级分辨率，最多包含九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
联合字段 destination。通知应发送到哪里。destination 只能是下列其中一项：
cloudPubsubTopic

object (CloudPubsubTopic)

要向其发送通知的 Cloud Pub/Sub 主题。

信息流

应用可注册接收的一类通知。例如：“网域的所有学生名单变动”。

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.
}
字段
feedType

enum (FeedType)

Feed 的类型。
联合字段 info。关于 Feed 的其他参数。info 只能是下列其中一项：
courseRosterChangesInfo

object (CourseRosterChangesInfo)

有关 feedType 为 COURSE_ROSTER_CHANGES 的 Feed 的信息。如果 feedType 为 COURSE_ROSTER_CHANGES，则必须指定此字段。
courseWorkChangesInfo

object (CourseWorkChangesInfo)

有关 feedType 为 COURSE_WORK_CHANGES 的 Feed 的信息。如果 feedType 为 COURSE_WORK_CHANGES，则必须指定此字段。

FeedType

一种 Feed，应用可注册从中接收通知。

枚举
FEED_TYPE_UNSPECIFIED 不应返回或提供。
DOMAIN_ROSTER_CHANGES

特定网域的所有学生名单变动。

每当用户加入或离开课程时，系统都会生成通知。

创建或删除邀请时，系统不会生成任何通知，但当用户通过接受邀请加入课程时，系统会生成通知。
COURSE_ROSTER_CHANGES

特定课程的所有学生名单变动。

每当用户加入或离开课程时，系统都会生成通知。

创建或删除邀请时，系统不会生成任何通知，但当用户通过接受邀请加入课程时，系统会生成通知。
COURSE_WORK_CHANGES

特定课程的所有课程工作活动。

当创建或修改 CourseWork 或 StudentSubmission 对象时，系统会生成通知。在创建 StudentSubmission 对象时，系统不会生成与其父级 CourseWork 对象有关的创建或修改对象时生成的通知（但在创建或修改该 CourseWork 对象时，系统会生成通知）。

CourseRosterChangesInfo

有关 feedType 为 COURSE_ROSTER_CHANGES 的 Feed 的信息。

JSON 表示法 
{
  "courseId": string
}
字段
courseId

string

课程的 courseId，用于订阅学生名单变更。

CourseWorkChangesInfo

有关 feedType 为 COURSE_WORK_CHANGES 的 Feed 的信息。

JSON 表示法 
{
  "courseId": string
}
字段
courseId

string

要订阅其作业变更的课程的 courseId。

CloudPubsubTopic

对 Cloud Pub/Sub 主题的引用。

如需注册接收通知，主题的所有者必须向 classroom-notifications@system.gserviceaccount.com 授予 projects.topics.publish 权限。

JSON 表示法 
{
  "topicName": string
}
字段
topicName

string

Cloud Pub/Sub 主题的 name 字段。

方法

create

 创建 Registration，使 Google 课堂开始从提供的 feed 向 cloudPubSubTopic 中提供的目标位置发送通知。

delete

 删除Registration，这会使 Google 课堂停止发送该Registration的通知。