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".
לאן לשלוח את ההתראות. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
cloudPubsubTopic

object (CloudPubsubTopic)

הנושא ב-Cloud Pub/Sub שאליו נשלחות ההתראות.
סוף השדות שמוציאים זה את זה.

פיד

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

ייצוג ב-JSON 
{
  "feedType": enum (FeedType),

  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
}
שדות
feedType

enum (FeedType)

סוג הפיד.
פרמטרים נוספים לגבי הפיד. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
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.