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 มีผล

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

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