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

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

טיפוסים בני מנייה (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

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.