Method: courses.aliases.list

Zwraca listę aliasów kursu.

Ta metoda zwraca następujące kody błędów:

  • PERMISSION_DENIED, jeśli użytkownik wysyłający prośbę nie ma uprawnień dostępu do kursu lub występuje błąd dostępu.
  • NOT_FOUND, jeśli kurs nie istnieje.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
courseId

string

Identyfikator zajęć. Może to być identyfikator przypisany przez Classroom lub alias.

Parametry zapytania

Parametry
pageSize

integer

Maksymalna liczba produktów do zwrócenia. Wartość zero lub nieokreślona oznacza, że serwer może przypisać wartość maksymalną.

Serwer może zwrócić mniej wyników niż określono.
pageToken

string

Wartość nextPageToken zwrócona z poprzedniego wywołania list, która wskazuje, że powinna zostać zwrócona kolejna strona z wynikami.

Żądanie list musi być w inny sposób identyczne z żądaniem, które spowodowało ten token.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź dotycząca listy aliasów kursów.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "aliases": [
    {
      object (CourseAlias)
    }
  ],
  "nextPageToken": string
}
Pola
aliases[]

object (CourseAlias)

Aliasy zajęć.
nextPageToken

string

Token określający następną stronę wyników do zwrócenia. Jeśli pole jest puste, kolejne wyniki nie są dostępne.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.