REST Resource: courses.announcements

Resource: Announcement

Announcement created by a teacher for students of the course

JSON representation
{
  "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,
}
Fields
courseId

string

Identifier of the course.

Read-only.

id

string

Classroom-assigned identifier of this announcement, unique per course.

Read-only.

text

string

Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.

materials[]

object(Material)

Additional materials.

Announcements must have no more than 20 material items.

state

enum(AnnouncementState)

Status of this announcement. If unspecified, the default state is DRAFT.

creationTime

string (Timestamp format)

Timestamp when this announcement was created.

Read-only.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Timestamp of the most recent change to this announcement.

Read-only.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

scheduledTime

string (Timestamp format)

Optional timestamp when this announcement is scheduled to be published.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

assigneeMode

enum(AssigneeMode)

Assignee mode of the announcement. If unspecified, the default value is ALL_STUDENTS.

individualStudentsOptions

object(IndividualStudentsOptions)

Identifiers of students with access to the announcement. This field is set only if assigneeMode is INDIVIDUAL_STUDENTS. If the assigneeMode is INDIVIDUAL_STUDENTS, then only students specified in this field will be able to see the announcement.

creatorUserId

string

Identifier for the user that created the announcement.

Read-only.

AnnouncementState

Possible states of announcements

Enums
ANNOUNCEMENT_STATE_UNSPECIFIED No state specified. This is never returned.
PUBLISHED Status for announcement that has been published. This is the default state.
DRAFT Status for an announcement that is not yet published. Announcement in this state is visible only to course teachers and domain administrators.
DELETED Status for announcement that was published but is now deleted. Announcement in this state is visible only to course teachers and domain administrators. Announcement in this state is deleted after some time.

Methods

create

Creates an announcement.

delete

Deletes an announcement.

get

Returns an announcement.

list

Returns a list of announcements that the requester is permitted to view.

modifyAssignees

Modifies assignee mode and options of an announcement.

patch

Updates one or more fields of an announcement.

Send feedback about...

Classroom API
Classroom API