REST Resource: registrations

资源：Registration

指示 Google 将 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)

“课堂”应发送到目标位置的通知类别规范。
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 对象后，系统会发送通知。当因创建或修改其父级 CourseWork 对象而创建 StudentSubmission 对象时，系统不会生成任何通知（但会在该 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”的通知。