REST Resource: registrations

资源：注册

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

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

object (CourseWorkChangesInfo)

Feed 的相关信息，其 feedType 为 COURSE_WORK_CHANGES。如果 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 的通知。