REST Resource: registrations

Kaynak: Kayıt

Classroom'a, feed adresinden bildirim göndermesi talimatı.

JSON gösterimi
{
  "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.
}
Alanlar
registrationId

string

Bu Registration için sunucu tarafından oluşturulan benzersiz tanımlayıcı.

Salt okunur.

feed

object (Feed)

Classroom'un hedefe iletmesi gereken bildirim sınıfıyla ilgili spesifikasyon.

expiryTime

string (Timestamp format)

Registration tarihine kadar geçerlidir.

Bu, sunucu tarafından atanan salt okunur bir alandır.

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanır. "Z" dışındaki saat farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

Birleştirme alanı destination. Bildirimlerin gönderileceği yer. destination yalnızca aşağıdakilerden biri olabilir:
cloudPubsubTopic

object (CloudPubsubTopic)

Bildirimlerin gönderileceği Cloud Pub/Sub konusu.

Feed

Bir uygulamanın almak için kaydolabileceği bildirim sınıfı. Örneğin: "Bir alanla ilgili tüm liste değişiklikleri".

JSON gösterimi
{
  "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.
}
Alanlar
feedType

enum (FeedType)

Feed'in türü.

Birleştirme alanı info. Feed ile ilgili ek parametreler. info yalnızca aşağıdakilerden biri olabilir:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

COURSE_ROSTER_CHANGES feedType'li bir Feed hakkındaki bilgiler. feedType, COURSE_ROSTER_CHANGES ise bu alan belirtilmelidir.

courseWorkChangesInfo

object (CourseWorkChangesInfo)

COURSE_WORK_CHANGES feedType'li bir Feed hakkındaki bilgiler. feedType, COURSE_WORK_CHANGES ise bu alan belirtilmelidir.

FeedType

Bir uygulamanın bildirim almak için kaydolabileceği bir feed türü.

Sıralamalar
FEED_TYPE_UNSPECIFIED Asla döndürülmemeli veya sağlanmamalıdır.
DOMAIN_ROSTER_CHANGES

Belirli bir alanla ilgili tüm liste değişiklikleri.

Kullanıcılar bir kursa katıldığında veya kurstan ayrıldığında bildirimler oluşturulur.

Davetiye oluşturulduğunda veya silindiğinde bildirim oluşturulmaz ancak kullanıcı davetiyeyi kabul ederek kursa katıldığında bildirim oluşturulur.

COURSE_ROSTER_CHANGES

Belirli bir kursla ilgili tüm sınıf listesi değişiklikleri.

Kullanıcılar bir kursa katıldığında veya kurstan ayrıldığında bildirimler oluşturulur.

Davetiye oluşturulduğunda veya silindiğinde bildirim oluşturulmaz ancak kullanıcı davetiyeyi kabul ederek kursa katıldığında bildirim oluşturulur.

COURSE_WORK_CHANGES

Belirli bir kursla ilgili tüm kurs çalışması etkinlikleri.

CourseWork veya StudentSubmission nesnesi oluşturulduğunda ya da değiştirildiğinde bildirimler oluşturulur. Üst CourseWork nesnesinin oluşturulması veya değiştirilmesiyle bağlantılı olarak bir StudentSubmission nesnesi oluşturulduğunda bildirim oluşturulmaz (ancak söz konusu CourseWork nesnesinin oluşturulması veya değiştirilmesi için bildirim oluşturulur).

CourseRosterChangesInfo

COURSE_ROSTER_CHANGES feedType'li bir Feed hakkındaki bilgiler.

JSON gösterimi
{
  "courseId": string
}
Alanlar
courseId

string

Kayıt listesi değişikliklerine abone olunacak kursun courseId.

CourseWorkChangesInfo

COURSE_WORK_CHANGES feedType'li bir Feed hakkındaki bilgiler.

JSON gösterimi
{
  "courseId": string
}
Alanlar
courseId

string

Çalışma değişikliklerine abone olunacak kursun courseId.

CloudPubsubTopic

Cloud Pub/Sub konusuna referans.

Bildirimlere kaydolmak için konunun sahibi classroom-notifications@system.gserviceaccount.com kullanıcısına projects.topics.publish izni vermelidir.

JSON gösterimi
{
  "topicName": string
}
Alanlar
topicName

string

Cloud Pub/Sub Konusu'nun name alanı.

Yöntemler

create

Registration oluşturur. Bu işlem, Classroom'un feed içinde belirtilen hedefe, cloudPubSubTopic içinde belirtilen hedeften bildirim göndermeye başlamasına neden olur.

delete

Registration öğesini siler. Bu durumda Classroom, söz konusu Registration ile ilgili bildirim göndermeyi durdurur.