Method: courses.aliases.list

Возвращает список псевдонимов курса.

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

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

HTTP-запрос

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

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

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

Параметры
courseId

string

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

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

Параметры
pageSize

integer

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

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

pageToken

string

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

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

Тело запроса

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

Тело ответа

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

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

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

object ( CourseAlias )

Псевдонимы курса.

nextPageToken

string

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

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

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

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

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