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 בתוקף.

זהו שדה לקריאה בלבד שהוקצה על ידי השרת.

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
שדה האיחוד destination. לאן צריך לשלוח את ההתראות. הערך של destination יכול להיות רק אחת מהאפשרויות הבאות:
cloudPubsubTopic

object (CloudPubsubTopic)

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

פיד

סוג של התראות שאפליקציה יכולה להירשם לקבלתן. לדוגמה: "all roster changes for a domain".

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