REST Resource: registrations

资源：Registration

向 Google 课堂发出指令，要求将通知从 feed 发送到提供的目的地。

JSON 表示法 
{
  "registrationId": string,
  "feed": {
    object (Feed)
  },
  "expiryTime": string,

  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
}
字段
registrationId

string

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

只读。
feed

object (Feed)

关于 Google 课堂应向目标位置发送的通知类别的规范说明。
expiryTime

string (Timestamp format)

Registration 的有效时间。

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

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
通知应发送到的位置。以下是互斥字段的列表。在响应中，最多只能设置以下字段之一：
cloudPubsubTopic

object (CloudPubsubTopic)

要向其发送通知的 Cloud Pub/Sub 主题。
互斥字段结束。

动态

应用可以注册接收的一类通知。例如：“网域的所有名单更改”。

JSON 表示法 
{
  "feedType": enum (FeedType),

  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
}
字段
feedType

enum (FeedType)

Feed 的类型。
关于 Feed 的其他参数。以下是互斥字段的列表。在响应中，最多只能设置以下字段之一：
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 的通知。