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.

نوع الخلاصة

نوع من الخلاصات التي يمكن أن يسجّلها التطبيق لتلقّي الإشعارات منه.

عمليات التعداد
FEED_TYPE_UNSPECIFIED يجب عدم إرجاعها أو تقديمها مطلقًا.
DOMAIN_ROSTER_CHANGES

جميع تغييرات قوائم النطاقات المحددة.

سيتم إنشاء إشعارات كلما انضم مستخدم إلى دورة تدريبية أو غادرها.

لن يتم إنشاء أي إشعارات عند إنشاء دعوة أو حذفها، ولكن سيتم إنشاء إشعارات عند انضمام أحد المستخدمين إلى دورة تدريبية من خلال قبول الدعوة.

COURSE_ROSTER_CHANGES

جميع تغييرات القائمة لدورة تدريبية معينة.

سيتم إنشاء إشعارات كلما انضم مستخدم إلى دورة تدريبية أو غادرها.

لن يتم إنشاء أي إشعارات عند إنشاء دعوة أو حذفها، ولكن سيتم إنشاء إشعارات عند انضمام أحد المستخدمين إلى دورة تدريبية من خلال قبول الدعوة.

COURSE_WORK_CHANGES

جميع أنشطة العمل لدورة تدريبية معيّنة.

سيتم إنشاء إشعارات عند إنشاء عنصر CourseWork أو StudentSubmission أو تعديله. لن يتم إنشاء أي إشعار عند إنشاء كائن StudentSubmission مرتبطًا بإنشاء كائن CourseWork الرئيسي أو تعديله (ولكن سيتم إنشاء إشعار لإنشاء عنصر CourseWork أو تعديله).

معلومات عن CourseRosterChanges

معلومات عن Feed باستخدام feedType من COURSE_ROSTER_CHANGES.

تمثيل JSON
{
  "courseId": string
}
الحقول
courseId

string

سيتم إجراء تغيير في courseId من الدورة التدريبية للاشتراك في القائمة.

معلومات عن تغييرات الدورة التدريبية

معلومات عن 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 لموضوع نشر/اشتراك في السحابة الإلكترونية.

الطُرق

create

يتم إنشاء Registration، ما يؤدي إلى بدء Classroom إرسال إشعارات من feed المقدَّمة إلى الوجهة المقدَّمة في cloudPubSubTopic.

delete

يؤدّي هذا الإجراء إلى حذف Registration، ما يؤدي إلى إيقاف Google Classroom لإرسال الإشعارات عن Registration.