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-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «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

نوعی فید که برنامه می‌تواند برای دریافت اعلان از آن ثبت‌نام کند.

شمارشی‌ها
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.

برای ثبت‌نام کردن برای اعلان‌ها، مالک موضوع باید اجازه projects.topics.publish را به classroom-notifications@system.gserviceaccount.com اعطا کند.

نمایش JSON 
{
  "topicName": string
}
فیلدها
topicName

string

فیلد name از موضوع Cloud Pub/Sub.

روش‌ها

create

 یک Registration ایجاد می‌کند که باعث می‌شود Classroom ارسال اعلان‌ها را از feed ارائه‌شده به مقصد ارائه‌شده در cloudPubSubTopic شروع کند.

delete

 Registration را حذف می‌کند و باعث می‌شود Classroom ارسال اعلان برای آن Registration را متوقف کند.