Method: courses.aliases.list

Zwraca listę aliasów zajęć.

Ta metoda zwraca te kody błędów:

  • PERMISSION_DENIED, jeśli użytkownik wysyłający prośbę nie ma dostępu do zajęć lub w przypadku błędów 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 do Classroom lub alias.

Parametry zapytania

Parametry
pageSize

integer

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

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

string

Wartość nextPageToken zwrócona z poprzedniego wywołania list, co oznacza, że powinna zostać zwrócona kolejna strona wyników.

Żądanie list musi być identyczne z żądaniem, które spowodowało wygenerowanie tego tokena.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź podczas wyświetlania listy aliasów zajęć.

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, nie są dostępne żadne dalsze wyniki.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.