REST Resource: registrations

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

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

การแสดง JSON 
{
  "registrationId": string,
  "feed": {
    object (Feed)
  },
  "expiryTime": string,

  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
}
ช่อง
registrationId

string

ตัวระบุที่ไม่ซ้ำกันซึ่งเซิร์ฟเวอร์สร้างขึ้นสำหรับ Registration นี้

อ่านอย่างเดียว
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"
ที่ที่ควรส่งการแจ้งเตือน ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
cloudPubsubTopic

object (CloudPubsubTopic)

หัวข้อ Cloud Pub/Sub ที่จะส่งการแจ้งเตือนไปให้
สิ้นสุดฟิลด์ที่แยกกัน

ฟีด

คลาสของการแจ้งเตือนที่แอปพลิเคชันสามารถลงทะเบียนเพื่อรับได้ เช่น "การเปลี่ยนแปลงบัญชีรายชื่อทั้งหมดสำหรับโดเมน"

การแสดง JSON 
{
  "feedType": enum (FeedType),

  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
}
ช่อง
feedType

enum (FeedType)

ประเภทของฟีด
พารามิเตอร์เพิ่มเติมเกี่ยวกับฟีด ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
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

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

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

หากต้องการลงทะเบียนรับการแจ้งเตือน เจ้าของหัวข้อต้องให้สิทธิ์ projects.topics.publish แก่ classroom-notifications@system.gserviceaccount.com

การแสดง JSON 
{
  "topicName": string
}
ช่อง
topicName

string

ช่อง name ของหัวข้อ Cloud Pub/Sub

เมธอด

create

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

delete

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