REST Resource: registrations

資源：Registration

指示 Classroom 透過 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 產生的專屬 ID。

唯讀。
feed

object (Feed)

指定 Classroom 應傳送至目的地的通知類別。
expiryTime

string (Timestamp format)

Registration 生效的時間。

這是伺服器指派的唯讀欄位。

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："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)

動態饋給類型。
聯集欄位 info。關於動態饋給的其他參數。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_TYPE_UNSPECIFIED 不得傳回或提供。
DOMAIN_ROSTER_CHANGES

變更特定網域的所有學生名單。

每當使用者加入或離開課程，系統就會發送通知。

建立或刪除邀請時，系統不會產生任何通知，但當使用者接受邀請加入課程時，即會產生通知。
COURSE_ROSTER_CHANGES

特定課程的所有學生名單變更。

每當使用者加入或離開課程，系統就會發送通知。

建立或刪除邀請時，系統不會產生任何通知，但當使用者接受邀請加入課程時，即會產生通知。
COURSE_WORK_CHANGES

特定課程的所有課程作業活動。

建立或修改 CourseWork 或 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 主題。

如要註冊通知，主題擁有者必須將 projects.topics.publish 權限授予 classroom-notifications@system.gserviceaccount.com。

JSON 表示法 
{
  "topicName": string
}
欄位
topicName

string

Cloud Pub/Sub 主題的 name 欄位。

方法

create

 建立 Registration，讓 Classroom 開始從提供的 feed 傳送通知到 cloudPubSubTopic 提供的目的地。

delete

 刪除Registration，導致 Classroom 停止傳送該Registration的通知。