REST Resource: courses.announcements

Ресурс: Объявление

Объявление, созданное преподавателем для студентов курса

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
}
Поля
courseId

string

Идентификатор курса.

Только для чтения.

id

string

Идентификатор данного объявления, присвоенный классу и уникальный для каждого курса.

Только для чтения.

text

string

Описание этого объявления. Текст должен представлять собой корректную строку в кодировке UTF-8, содержащую не более 30 000 символов.

materials[]

object ( Material )

Дополнительные материалы.

Объявления должны содержать не более 20 материальных единиц.

state

enum ( AnnouncementState )

Статус этого объявления. Если не указано иное, статус по умолчанию — DRAFT .

creationTime

string ( Timestamp format)

Временная метка создания данного объявления.

Только для чтения.

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

updateTime

string ( Timestamp format)

Временная метка последнего изменения в этом объявлении.

Только для чтения.

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

scheduledTime

string ( Timestamp format)

Необязательная временная метка, когда планируется публикация данного объявления.

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

assigneeMode

enum ( AssigneeMode )

Режим назначения объявления. Если не указано иное, по умолчанию используется значение ALL_STUDENTS .

individualStudentsOptions

object ( IndividualStudentsOptions )

Идентификаторы студентов, имеющих доступ к объявлению. Это поле заполняется только если assigneeMode — INDIVIDUAL_STUDENTS . Если assigneeMode — INDIVIDUAL_STUDENTS , то объявление смогут видеть только студенты, указанные в этом поле.

creatorUserId

string

Идентификатор пользователя, создавшего объявление.

Только для чтения.

ОбъявлениеState

Возможные состояния объявлений

Перечисления
ANNOUNCEMENT_STATE_UNSPECIFIED Состояние не указано. Этот параметр никогда не возвращается.
PUBLISHED Статус опубликованного объявления. Это состояние по умолчанию.
DRAFT Статус объявления, которое ещё не опубликовано. Объявление в этом статусе видят только преподаватели курса и администраторы домена.
DELETED Статус объявления, которое было опубликовано, но теперь удалено. Объявление в этом состоянии видно только преподавателям курса и администраторам домена. Объявление в этом состоянии удаляется через некоторое время.

Методы

create

 Создает объявление.

delete

 Удаляет объявление.

get

 Возвращает объявление.

getAddOnContext

 Получает метаданные для дополнений Classroom в контексте конкретной публикации.

list

 Возвращает список объявлений, которые разрешено просматривать запрашивающей стороне.

modifyAssignees

 Изменяет режим назначения и параметры объявления.

patch

 Обновляет одно или несколько полей объявления.