Method: courses.courseWorkMaterials.list

Возвращает список учебных материалов, к просмотру которых имеет право запросить данные.

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

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

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

HTTP-запрос

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

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

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

Параметры
courseId

string

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

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

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

enum ( CourseWorkMaterialState )

Ограничение по статусу работы для возврата. Возвращаются только соответствующие учебные материалы. Если статус не указан, возвращаются материалы со статусом работы PUBLISHED .

orderBy

string

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

pageSize

integer

Максимальное количество возвращаемых элементов. Ноль или неуказанное значение означает, что сервер может установить максимальное количество.

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

pageToken

string

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

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

materialDriveId

string

Дополнительная фильтрация для учебных материалов, содержащих хотя бы один материал на Google Диск, идентификатор которого соответствует указанной строке. Если также указан параметр materialLink , учебные материалы должны соответствовать обоим фильтрам.

previewVersion

enum ( PreviewVersion )

Необязательно. Предварительная версия API. Необходимо указать этот параметр для доступа к новым возможностям API, предоставляемым разработчикам в рамках программы предварительного просмотра.

Текст запроса

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

Ответный текст

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

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

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

object ( CourseWorkMaterial )

Материалы для учебной работы, соответствующие запросу.

nextPageToken

string

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

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

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

Для получения более подробной информации см. руководство по авторизации .