REST Resource: registrations

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

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

การแสดง 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 จะมีผล

นี่คือฟิลด์แบบอ่านอย่างเดียวที่เซิร์ฟเวอร์กำหนด

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "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)

ข้อมูลเกี่ยวกับ 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

หากต้องการลงทะเบียนรับการแจ้งเตือน เจ้าของหัวข้อต้องให้สิทธิ์แก่ 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 นั้น