REST Resource: registrations

Kaynak: Registration

Classroom'a, feed kaynağından sağlanan hedefe bildirim gönderme talimatı.

JSON gösterimi
{
  "registrationId": string,
  "feed": {
    object (Feed)
  },
  "expiryTime": string,

  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
}
Alanlar
registrationId

string

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

Salt okunur.

feed

object (Feed)

Classroom'un hedefe göndermesi gereken bildirim sınıfının spesifikasyonu.

expiryTime

string (Timestamp format)

Registration geçerli olduğu süre.

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

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

Bildirimlerin gönderileceği yer. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır:
cloudPubsubTopic

object (CloudPubsubTopic)

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

Birbirini hariç tutan alanların sonu.

Feed

Bir uygulamanın almak için kaydolabileceği bildirim sınıfı. Örneğin: "bir alan adının tüm öğrenci listesi değişiklikleri".

JSON gösterimi
{
  "feedType": enum (FeedType),

  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
}
Alanlar
feedType

enum (FeedType)

Feed'in türü.

Feed ile ilgili ek parametreler. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

COURSE_ROSTER_CHANGES değerinde feedType içeren Feed ile ilgili bilgiler. feedType, COURSE_ROSTER_CHANGES ise bu alan belirtilmelidir.

courseWorkChangesInfo

object (CourseWorkChangesInfo)

COURSE_WORK_CHANGES değerinde feedType içeren Feed ile ilgili bilgiler. feedType, COURSE_WORK_CHANGES ise bu alan belirtilmelidir.

Birbirini hariç tutan alanların sonu.

FeedType

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

Sıralamalar
FEED_TYPE_UNSPECIFIED Hiçbir zaman döndürülmemeli veya sağlanmamalıdır.
DOMAIN_ROSTER_CHANGES

Belirli bir alan için tüm öğrenci listesi değişiklikleri.

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

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

COURSE_ROSTER_CHANGES

Belirli bir kurs için tüm öğrenci listesi değişiklikleri.

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

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

COURSE_WORK_CHANGES

Belirli bir dersle ilgili tüm sınıf çalışması etkinlikleri

CourseWork veya StudentSubmission nesnesi oluşturulduğunda ya da değiştirildiğinde bildirimler oluşturulur. Bir StudentSubmission nesnesi, üst CourseWork nesnesinin oluşturulması veya değiştirilmesiyle bağlantılı olarak oluşturulduğunda bildirim oluşturulmaz (ancak bu CourseWork nesnesinin oluşturulması veya değiştirilmesi için bildirim oluşturulur).

CourseRosterChangesInfo

COURSE_ROSTER_CHANGES değerinde feedType içeren Feed ile ilgili bilgiler.

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

string

Öğrenci listesi değişikliklerine abone olunacak dersin courseId değeri.

CourseWorkChangesInfo

COURSE_WORK_CHANGES değerinde feedType içeren Feed ile ilgili bilgiler.

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

string

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

CloudPubsubTopic

Cloud Pub/Sub konusuna referans.

Bildirimlere kaydolmak için konunun sahibi classroom-notifications@system.gserviceaccount.com'e projects.topics.publish izni vermelidir.

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

string

Cloud Pub/Sub konusunun name alanı.

Yöntemler

create

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

delete

Bir Registration siler ve Classroom'un bu Registration için bildirim göndermeyi durdurmasına neden olur.