Method: courses.announcements.list

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

Студенты курса могут просматривать только PUBLISHED объявления. Преподаватели курсов и администраторы домена могут просматривать все объявления.

Этот метод возвращает следующие коды ошибок:

  • PERMISSION_DENIED если запрашивающему пользователю не разрешен доступ к запрошенному курсу или в случае ошибок доступа .
  • INVALID_ARGUMENT если запрос имеет неверный формат.
  • NOT_FOUND если запрошенный курс не существует.

HTTP-запрос

GET https://classroom.googleapis.com/v1/courses/{courseId}/announcements

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
courseId

string

Идентификатор курса. Этот идентификатор может быть либо идентификатором, присвоенным Классом, либо alias .

Параметры запроса

Параметры
announcementStates[]

enum ( AnnouncementState )

Возвращено ограничение на state объявлений. Если этот аргумент не указан, значение по умолчанию — PUBLISHED .

orderBy

string

Необязательный порядок сортировки результатов. Список полей, разделенных запятыми, с необязательным ключевым словом направления сортировки. Поддерживаемое поле — updateTime . Поддерживаемые ключевые слова направления: asc и desc . Если не указано, updateTime desc является поведением по умолчанию. Примеры: updateTime asc , updateTime

pageSize

integer

Максимальное количество товаров для возврата. Ноль или не указано означает, что сервер может назначить максимум.

Сервер может вернуть меньшее количество результатов, чем указано.

pageToken

string

Значение nextPageToken , возвращенное из предыдущего вызова list , указывает, что должна быть возвращена следующая страница результатов.

В остальном запрос list должен быть идентичен тому, который привел к получению этого токена.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ при перечислении курсовой работы.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "announcements": [
    {
      object (Announcement)
    }
  ],
  "nextPageToken": string
}
Поля
announcements[]

object ( Announcement )

Элементы объявления, соответствующие запросу.

nextPageToken

string

Токен, идентифицирующий следующую страницу результатов, которую нужно вернуть. Если пусто, дальнейшие результаты недоступны.

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/classroom.announcements
  • https://www.googleapis.com/auth/classroom.announcements.readonly

Дополнительную информацию см. в руководстве по авторизации .