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 的有效時間。

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

使用 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)

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

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

每當有使用者加入或退出課程，系統就會產生通知。

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

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

每當有使用者加入或退出課程，系統就會產生通知。

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

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

系統會在建立或修改 CourseWork 或 StudentSubmission 物件時產生通知。建立或修改父項 CourseWork 物件時，系統不會產生與該物件相關的 StudentSubmission 物件通知 (但會產生該 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，讓 Classroom 開始從提供的 feed 將通知傳送至 cloudPubSubTopic 中提供的目的地。

delete

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