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.

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

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

object (CloudPubsubTopic)

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

פיד

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

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

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

טיפוסים בני מנייה (enums)
FEED_TYPE_UNSPECIFIED אין להחזיר או לספק אותם.
DOMAIN_ROSTER_CHANGES

כל השינויים ברשימת השמות בדומיין מסוים.

ההתראות נוצרות בכל פעם שמשתמש מצטרף לקורס או עוזב אותו.

לא יופקו התראות בעת יצירה או מחיקה של הזמנה, אך ייווצרו התראות כאשר משתמש מצטרף לקורס על ידי אישור ההזמנה.
COURSE_ROSTER_CHANGES

כל השינויים ברשימת התלמידים בקורס מסוים.

ההתראות נוצרות בכל פעם שמשתמש מצטרף לקורס או עוזב אותו.

לא יופקו התראות בעת יצירה או מחיקה של הזמנה, אך ייווצרו התראות כאשר משתמש מצטרף לקורס על ידי אישור ההזמנה.
COURSE_WORK_CHANGES

כל הפעילויות בקורס מסוים.

התראות יישלחו כשהמערכת תיצור או תשנה אובייקט של CourseWork או TeacherSubmission. לא תיווצר התראה בכל פעם שנוצר אובייקט MemberSubmission בקשר ליצירה או לשינוי של אובייקט 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.

שיטות

create

 הפונקציה יוצרת Registration וגורמת ל-Classroom להתחיל לשלוח התראות מה-feed שסופק אל היעד שצוין ב-cloudPubSubTopic.

delete

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