מקור מידע: הרשמה
הוראה ל-Classroom לשלוח התראות מה-feed
ליעד שצוין.
ייצוג ב-JSON |
---|
{ "registrationId": string, "feed": { object ( |
שדות | |
---|---|
registration |
מזהה ייחודי שנוצר על ידי השרת עבור קריאה בלבד. |
feed |
מפרט של סוג ההתראות שמערכת Classroom צריכה לשלוח ליעד. |
expiry |
הזמן שבו זהו שדה לקריאה בלבד שהוקצה על ידי השרת. חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
שדה האיחוד destination . לאן צריך לשלוח את ההתראות. הערך של destination יכול להיות רק אחת מהאפשרויות הבאות: |
|
cloud |
הנושא ב-Cloud Pub/Sub שאליו יישלחו ההתראות. |
פיד
סוג של התראות שאפליקציה יכולה להירשם לקבלתן. לדוגמה: "all roster changes for a domain".
ייצוג ב-JSON |
---|
{ "feedType": enum ( |
שדות | |
---|---|
feed |
סוג הפיד. |
שדה האיחוד info . פרמטרים נוספים לגבי הפיד. הערך של info יכול להיות רק אחת מהאפשרויות הבאות: |
|
course |
מידע על |
course |
מידע על |
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 } |
שדות | |
---|---|
course |
ה- |
CourseWorkChangesInfo
מידע על Feed
עם feedType
של COURSE_WORK_CHANGES
.
ייצוג ב-JSON |
---|
{ "courseId": string } |
שדות | |
---|---|
course |
ה- |
CloudPubsubTopic
הפניה לנושא ב-Cloud Pub/Sub.
כדי להירשם לקבלת התראות, הבעלים של הנושא צריך להעניק ל-classroom-notifications@system.gserviceaccount.com
את ההרשאה projects.topics.publish
.
ייצוג ב-JSON |
---|
{ "topicName": string } |
שדות | |
---|---|
topic |
השדה |
Methods |
|
---|---|
|
יוצרת Registration , וכתוצאה מכך מערכת Classroom מתחילה לשלוח התראות מה-feed שצוין ליעד שצוין ב-cloudPubSubTopic . |
|
מחיקת Registration , וכתוצאה מכך Classroom יפסיק לשלוח התראות לגבי Registration הזה. |