משאב: רישום
הוראה ל-Classroom לשלוח הודעות מ-feed
ליעד שסופק.
ייצוג JSON |
---|
{ "registrationId": string, "feed": { object ( |
שדות | |
---|---|
registrationId |
מזהה ייחודי שנוצר על ידי השרת עבור קריאה בלבד. |
feed |
מפרט של סיווג ההתראות שמערכת Classroom צריכה לשלוח ליעד. |
expiryTime |
פרק הזמן שעד אליו זהו שדה לקריאה בלבד שמוקצה על ידי השרת. חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
שדה איחוד destination . לאן צריך לשלוח את ההתראות. destination יכול להיות רק אחת מהאפשרויות הבאות: |
|
cloudPubsubTopic |
הנושא ב-Cloud Pub/Sub שאליו יישלחו ההתראות. |
פיד
סיווג של התראות שאפליקציה יכולה להירשם לקבלת. לדוגמה: 'כל השינויים ברשימת האומנים עבור דומיין מסוים'.
ייצוג JSON |
---|
{ "feedType": enum ( |
שדות | |
---|---|
feedType |
סוג הפיד. |
שדה איחוד info . פרמטרים נוספים לגבי הפיד. info יכול להיות רק אחת מהאפשרויות הבאות: |
|
courseRosterChangesInfo |
מידע על |
courseWorkChangesInfo |
מידע על |
FeedType
סוג פיד שהאפליקציה יכולה לרשום ממנו לקבלת התראות.
טיפוסים בני מנייה (enum) | |
---|---|
FEED_TYPE_UNSPECIFIED |
אין להחזיר או לספק אותה. |
DOMAIN_ROSTER_CHANGES |
כל השינויים ברשימת האומנים עבור דומיין מסוים. המערכת תיצור התראות בכל פעם שמשתמש יצטרף לקורס או יעזוב אותו. לא ייווצרו התראות כשהזמנה נוצרת או נמחקת, אבל התראות ייווצרו כשמשתמש מצטרף לקורס על ידי אישור הזמנה. |
COURSE_ROSTER_CHANGES |
כל השינויים ברשימה עבור קורס מסוים. המערכת תיצור התראות בכל פעם שמשתמש יצטרף לקורס או יעזוב אותו. לא ייווצרו התראות כשהזמנה נוצרת או נמחקת, אבל התראות ייווצרו כשמשתמש מצטרף לקורס על ידי אישור הזמנה. |
COURSE_WORK_CHANGES |
כל פעילות העבודה בקורס מסוים. התראות ייווצרו בזמן יצירה או שינוי של אובייקט CourseWork או סטודנטSubmission. לא תיווצר התראה כשאובייקט ClassroomSubmission נוצר בקשר ליצירה או לשינוי של אובייקט ההורה CourseWork (אבל נוצרת התראה על היצירה או השינוי של אובייקט CourseWork). |
CourseRosterChangesInfo
מידע על Feed
עם feedType
מסוג COURSE_ROSTER_CHANGES
.
ייצוג JSON |
---|
{ "courseId": string } |
שדות | |
---|---|
courseId |
|
CourseWorkChangesInfo
מידע על Feed
עם feedType
מסוג COURSE_WORK_CHANGES
.
ייצוג JSON |
---|
{ "courseId": string } |
שדות | |
---|---|
courseId |
|
CloudPubsubTopic
הפניה לנושא ב-Cloud Pub/Sub.
כדי להירשם לקבלת התראות, הבעלים של הנושא צריך להעניק ל-classroom-notifications@system.gserviceaccount.com
את ההרשאה projects.topics.publish
.
ייצוג JSON |
---|
{ "topicName": string } |
שדות | |
---|---|
topicName |
השדה |
שיטות |
|
---|---|
|
יוצרת Registration , וכתוצאה מכך מערכת Classroom מתחילה לשלוח התראות מה-feed שסופק ליעד שצוין ב-cloudPubSubTopic . |
|
נמחק Registration , וכתוצאה מכך מערכת Classroom מפסיקה לשלוח התראות לגבי Registration . |