REST Resource: courses.announcements

Resource: Pengumuman

Pengumuman yang dibuat oleh pengajar untuk siswa dalam kursus

Representasi JSON
{
  "courseId": string,
  "id": string,
  "text": string,
  "materials": [
    {
      object (Material)
    }
  ],
  "state": enum (AnnouncementState),
  "alternateLink": string,
  "creationTime": string,
  "updateTime": string,
  "scheduledTime": string,
  "assigneeMode": enum (AssigneeMode),
  "individualStudentsOptions": {
    object (IndividualStudentsOptions)
  },
  "creatorUserId": string
}
Kolom
courseId

string

ID kursus.

Hanya baca.

id

string

ID yang ditetapkan Classroom untuk pengumuman ini, unik per mata pelajaran.

Hanya baca.

text

string

Deskripsi pengumuman ini. Teks harus berupa string UTF-8 yang valid dan tidak boleh berisi lebih dari 30.000 karakter.

materials[]

object (Material)

Materi tambahan.

Pengumuman tidak boleh memiliki lebih dari 20 item materi.

state

enum (AnnouncementState)

Status pengumuman ini. Jika tidak ditentukan, status defaultnya adalah DRAFT.

creationTime

string (Timestamp format)

Stempel waktu saat pengumuman ini dibuat.

Hanya baca.

Menggunakan RFC 3339, dengan output yang dihasilkan 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".

updateTime

string (Timestamp format)

Stempel waktu perubahan terbaru pada pengumuman ini.

Hanya baca.

Menggunakan RFC 3339, dengan output yang dihasilkan 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".

scheduledTime

string (Timestamp format)

Stempel waktu opsional saat pengumuman ini dijadwalkan untuk dipublikasikan.

Menggunakan RFC 3339, dengan output yang dihasilkan 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".

assigneeMode

enum (AssigneeMode)

Mode penerima tugas pengumuman. Jika tidak ditentukan, nilai defaultnya adalah ALL_STUDENTS.

individualStudentsOptions

object (IndividualStudentsOptions)

ID siswa yang memiliki akses ke pengumuman. Kolom ini hanya disetel jika assigneeMode adalah INDIVIDUAL_STUDENTS. Jika assigneeMode adalah INDIVIDUAL_STUDENTS, hanya siswa yang ditentukan di kolom ini yang dapat melihat pengumuman.

creatorUserId

string

ID pengguna yang membuat pengumuman.

Hanya baca.

AnnouncementState

Kemungkinan status pengumuman

Enum
ANNOUNCEMENT_STATE_UNSPECIFIED Negara bagian tidak ditentukan. Ini tidak pernah ditampilkan.
PUBLISHED Status untuk pengumuman yang telah dipublikasikan. Ini adalah status default.
DRAFT Status untuk pengumuman yang belum dipublikasikan. Pengumuman dalam status ini hanya dapat dilihat oleh pengajar kursus dan administrator domain.
DELETED Status untuk pengumuman yang dipublikasikan, tetapi sekarang dihapus. Pengumuman dalam status ini hanya dapat dilihat oleh pengajar kursus dan administrator domain. Pengumuman dalam status ini akan dihapus setelah beberapa waktu.

Metode

create

Membuat pengumuman.

delete

Menghapus pengumuman.

get

Menampilkan pengumuman.

getAddOnContext

Mendapatkan metadata untuk add-on Classroom dalam konteks postingan tertentu.

list

Menampilkan daftar pengumuman yang diizinkan untuk dilihat oleh pemohon.

modifyAssignees

Mengubah mode dan opsi penerima tugas pengumuman.

patch

Memperbarui satu atau beberapa kolom pengumuman.