REST Resource: registrations

Resource: Pendaftaran

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

Representasi 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.
}
Kolom
registrationId

string

ID unik yang dibuat 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 menjadi efektif.

Ini adalah bidang hanya baca yang ditetapkan oleh server.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
Kolom union destination. Tujuan pengiriman notifikasi. destination hanya dapat berupa salah satu dari berikut:
cloudPubsubTopic

object (CloudPubsubTopic)

Topik Cloud Pub/Sub yang menjadi tujuan pengiriman notifikasi.

Feed

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

Representasi 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.
}
Kolom
feedType

enum (FeedType)

Jenis feed.
Kolom union info. Parameter tambahan tentang feed. info hanya dapat berupa salah satu dari berikut:
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.

FeedType

Jenis feed yang dapat didaftarkan aplikasi untuk notifikasinya.

Enum
FEED_TYPE_UNSPECIFIED Tidak boleh dikembalikan atau diberikan.
DOMAIN_ROSTER_CHANGES

Semua perubahan daftar nama untuk domain tertentu.

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

Tidak ada notifikasi yang 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 siswa untuk kursus tertentu.

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

Tidak ada notifikasi yang akan dibuat saat undangan dibuat atau dihapus, tetapi notifikasi akan dibuat saat pengguna bergabung ke kursus dengan menerima undangan.
COURSE_WORK_CHANGES

Semua aktivitas kerja untuk materi tertentu.

Notifikasi akan dibuat saat objek CourseWork atau StudentSubmission dibuat atau diubah. Tidak ada notifikasi yang akan dibuat saat objek Tugas Pelajar dibuat sehubungan dengan pembuatan atau perubahan 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 siswa.

CourseWorkChangesInfo

Informasi tentang Feed dengan feedType COURSE_WORK_CHANGES.

Representasi JSON 
{
  "courseId": string
}
Kolom
courseId

string

courseId kursus untuk berlangganan perubahan pekerjaan.

CloudPubsubTopic

Referensi ke topik Cloud Pub/Sub.

Untuk mendaftar agar bisa mendapatkan notifikasi, pemilik topik harus memberi classroom-notifications@system.gserviceaccount.com izin projects.topics.publish.

Representasi JSON 
{
  "topicName": string
}
Kolom
topicName

string

Kolom name dari Topik Cloud Pub/Sub.

Metode

create

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

delete

 Menghapus Registration, yang menyebabkan Classroom berhenti mengirim notifikasi untuk Registration tersebut.