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 class notifikasi yang harus dikirimkan Classroom ke tujuan.
expiryTime

string (Timestamp format)

Waktu hingga Registration berlaku.

Kolom ini adalah kolom hanya baca yang ditetapkan oleh server.

Stempel waktu dalam format 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 akan dikirimi notifikasi.

Feed

Class notifikasi yang dapat didaftarkan aplikasi untuk diterima. Misalnya: "semua daftar nama siswa diubah 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 dari COURSE_ROSTER_CHANGES. Kolom ini harus ditentukan jika feedType adalah COURSE_ROSTER_CHANGES.
courseWorkChangesInfo

object (CourseWorkChangesInfo)

Informasi tentang Feed dengan feedType dari COURSE_WORK_CHANGES. Kolom ini harus ditentukan jika feedType adalah COURSE_WORK_CHANGES.

Jenis Feed

Jenis feed yang dapat didaftarkan aplikasi untuk notifikasi.

Enumerasi
FEED_TYPE_UNSPECIFIED Tidak boleh dikembalikan atau diberikan.
DOMAIN_ROSTER_CHANGES

Semua perubahan daftar nama siswa 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 tugas mata pelajaran 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).

InfoRo MenggunakanPerubahan

Informasi tentang Feed dengan feedType dari COURSE_ROSTER_CHANGES.

Representasi JSON 
{
  "courseId": string
}
Kolom
courseId

string

courseId kursus untuk berlangganan perubahan daftar nama siswa.

InfoPerubahan Kursus

Informasi tentang Feed dengan feedType dari COURSE_WORK_CHANGES.

Representasi JSON 
{
  "courseId": string
}
Kolom
courseId

string

courseId kursus untuk berlangganan perubahan pekerjaan.

CloudPubSubTopic

Referensi ke topik Cloud Pub/Sub.

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

Representasi JSON 
{
  "topicName": string
}
Kolom
topicName

string

Kolom name pada Pub Cloud Pub/Sub.

Metode

create

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

delete

 Menghapus Registration yang menyebabkan Classroom berhenti mengirimkan notifikasi untuk Registration tersebut.