REST Resource: registrations

แหล่งข้อมูล: การลงทะเบียน

คำสั่งให้ 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 นี้

อ่านอย่างเดียว
feed

object (Feed)

ข้อกำหนดสำหรับคลาสการแจ้งเตือนที่ Classroom ควรส่งไปยังปลายทาง
expiryTime

string (Timestamp format)

ระยะเวลาที่ Registration จะมีผล

ฟิลด์นี้เป็นฟิลด์แบบอ่านอย่างเดียวที่กำหนดโดยเซิร์ฟเวอร์

ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 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

ประเภทฟีดที่แอปพลิเคชันสามารถลงทะเบียนเพื่อรับการแจ้งเตือนได้

Enum
FEED_TYPE_UNSPECIFIED ไม่ควรส่งคืนหรือระบุ
DOMAIN_ROSTER_CHANGES

การเปลี่ยนแปลงทั้งหมดในบัญชีผู้ใช้ของโดเมนหนึ่งๆ

ระบบจะสร้างการแจ้งเตือนทุกครั้งที่ผู้ใช้เข้าร่วมหรือออกจากหลักสูตร

ระบบจะไม่สร้างการแจ้งเตือนเมื่อสร้างหรือลบคำเชิญ แต่ระบบจะสร้างการแจ้งเตือนเมื่อผู้ใช้เข้าร่วมหลักสูตรโดยตอบรับคำเชิญ
COURSE_ROSTER_CHANGES

การเปลี่ยนแปลงบัญชีรายชื่อทั้งหมดสำหรับหลักสูตรหนึ่งๆ

ระบบจะสร้างการแจ้งเตือนทุกครั้งที่ผู้ใช้เข้าร่วมหรือออกจากหลักสูตร

ระบบจะไม่สร้างการแจ้งเตือนเมื่อสร้างหรือลบคำเชิญ แต่ระบบจะสร้างการแจ้งเตือนเมื่อผู้ใช้เข้าร่วมหลักสูตรโดยตอบรับคำเชิญ
COURSE_WORK_CHANGES

กิจกรรมงานในหลักสูตรทั้งหมดของหลักสูตรหนึ่งๆ

ระบบจะสร้างการแจ้งเตือนเมื่อมีการสร้างหรือแก้ไขออบเจ็กต์งานหรือการส่งของนักเรียน ระบบจะไม่สร้างการแจ้งเตือนเมื่อสร้างออบเจ็กต์ 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

ฟิลด์ name ของหัวข้อ Cloud Pub/Sub

เมธอด

create

 สร้าง Registration ซึ่งจะทำให้ Classroom เริ่มส่งการแจ้งเตือนจาก feed ที่ระบุไปยังปลายทางที่ระบุใน cloudPubSubTopic

delete

 ลบ Registration ซึ่งจะทำให้ Classroom หยุดส่งการแจ้งเตือนสำหรับ Registration นั้น