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)

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，则必须指定此字段。

Feed 类型

应用可以注册以接收通知的 Feed 类型。

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

特定网域的所有学生名单更改。

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

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

特定课程的所有学生名单更改。

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

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

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

系统会在创建或修改 CourseWork 或 StudentSubmission 对象时生成通知。如果创建与创建其父级 CourseWork 对象相关的 StudentSubmission 对象，将不会生成通知（但系统会为课程 CourseWork 对象的创建或修改操作生成通知）。

课程名单变更信息

feedType 为 COURSE_ROSTER_CHANGES 的 Feed 的相关信息。

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

string

要订阅名单更改的课程的 courseId。

课程更改变更信息

feedType 为 COURSE_WORK_CHANGES 的 Feed 的相关信息。

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

string

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

CloudPub 子主题

对 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的通知。