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 的有效时间。

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

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
联合字段 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

Feed 的相关信息，其中 feedType 为 COURSE_ROSTER_CHANGES。

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

string

要订阅的课程的 courseId，以接收有关名单变更的通知。

CourseWorkChangesInfo

Feed 的相关信息，其中 feedType 为 COURSE_WORK_CHANGES。

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