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 ושימוש ב-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)

נושא Pub/Sub ב-Cloud שאליו יישלחו ההתראות.

פיד

סוג של התראות שאפליקציה יכולה להירשם לקבלתן. לדוגמה: "כל השינויים ברשימת התלמידים בדומיין".

ייצוג ב-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.

Methods

create

 יוצרת Registration, וכתוצאה מכך Classroom מתחילה לשלוח התראות מה-feed שצוין ליעד שצוין ב-cloudPubSubTopic.

delete

 מחיקת Registration גורמת ל-Classroom להפסיק לשלוח התראות לגבי אותו Registration.