REST Resource: registrations

Resource: Registration

Petunjuk ke Classroom untuk mengirim notifikasi dari feed ke tujuan yang diberikan.

Representasi JSON 
{
  "registrationId": string,
  "feed": {
    object (Feed)
  },
  "expiryTime": string,

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

string

ID unik yang dihasilkan server untuk Registration ini.

Hanya baca.
feed

object (Feed)

Spesifikasi untuk kelas notifikasi yang harus dikirimkan Classroom ke tujuan.
expiryTime

string (Timestamp format)

Waktu hingga Registration berlaku.

Kolom ini bersifat hanya baca dan ditetapkan oleh server.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
Tujuan pengiriman notifikasi. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
cloudPubsubTopic

object (CloudPubsubTopic)

Topik Cloud Pub/Sub yang akan dikirimi notifikasi.
Akhir kolom yang saling eksklusif.

Feed

Class notifikasi yang dapat didaftarkan oleh aplikasi untuk diterima. Misalnya: "semua perubahan daftar nama untuk domain".

Representasi JSON 
{
  "feedType": enum (FeedType),

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

enum (FeedType)

Jenis feed.
Parameter tambahan tentang feed. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

Informasi tentang Feed dengan feedType COURSE_ROSTER_CHANGES. Kolom ini harus ditentukan jika feedType adalah COURSE_ROSTER_CHANGES.
courseWorkChangesInfo

object (CourseWorkChangesInfo)

Informasi tentang Feed dengan feedType COURSE_WORK_CHANGES. Kolom ini harus ditentukan jika feedType adalah COURSE_WORK_CHANGES.
Akhir kolom yang saling eksklusif.

FeedType

Jenis feed yang dapat didaftarkan oleh aplikasi untuk menerima notifikasi.

Enum
FEED_TYPE_UNSPECIFIED Tidak boleh ditampilkan atau diberikan.
DOMAIN_ROSTER_CHANGES

Semua perubahan daftar nama untuk domain tertentu.

Notifikasi akan dibuat setiap kali pengguna bergabung atau keluar dari kursus.

Notifikasi tidak akan dibuat saat undangan dibuat atau dihapus, tetapi notifikasi akan dibuat saat pengguna bergabung ke kursus dengan menerima undangan.
COURSE_ROSTER_CHANGES

Semua perubahan daftar nama untuk kursus tertentu.

Notifikasi akan dibuat setiap kali pengguna bergabung atau keluar dari kursus.

Notifikasi tidak akan dibuat saat undangan dibuat atau dihapus, tetapi notifikasi akan dibuat saat pengguna bergabung ke kursus dengan menerima undangan.
COURSE_WORK_CHANGES

Semua aktivitas tugas untuk kursus tertentu.

Notifikasi akan dibuat saat objek CourseWork atau StudentSubmission dibuat atau diubah. Tidak ada notifikasi yang akan dibuat saat objek StudentSubmission dibuat sehubungan dengan pembuatan atau modifikasi objek CourseWork induknya (tetapi notifikasi akan dibuat untuk pembuatan atau modifikasi objek CourseWork tersebut).

CourseRosterChangesInfo

Informasi tentang Feed dengan feedType COURSE_ROSTER_CHANGES.

Representasi JSON 
{
  "courseId": string
}
Kolom
courseId

string

courseId kursus untuk berlangganan perubahan daftar nama.

CourseWorkChangesInfo

Informasi tentang Feed dengan feedType COURSE_WORK_CHANGES.

Representasi JSON 
{
  "courseId": string
}
Kolom
courseId

string

courseId kursus yang akan berlangganan perubahan tugas.

CloudPubsubTopic

Referensi ke topik Cloud Pub/Sub.

Untuk mendaftar ke notifikasi, pemilik topik harus memberikan izin projects.topics.publish kepada classroom-notifications@system.gserviceaccount.com.

Representasi JSON 
{
  "topicName": string
}
Kolom
topicName

string

Kolom name dari Topik Cloud Pub/Sub.

Metode

create

 Membuat Registration, yang menyebabkan Classroom mulai mengirimkan notifikasi dari feed yang disediakan ke tujuan yang disediakan di cloudPubSubTopic.

delete

 Menghapus Registration, sehingga Classroom berhenti mengirimkan notifikasi untuk Registration tersebut.