Method: courses.aliases.list

Zwraca listę aliasów kursu.

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

  • PERMISSION_DENIED jeśli użytkownik nie ma dostępu do kursu lub wystąpiły błędy 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 kursu. Identyfikatorem może być identyfikator przypisany przez Classroom lub alias.

Parametry zapytania

Parametry
pageSize

integer

Maksymalna liczba elementów do zwrócenia. Wartość 0 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, wskazująca, że należy zwrócić kolejną stronę wyników.

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

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na żądanie wyświetlenia aliasów kursu.

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

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

object (CourseAlias)

Aliasy kursu.
nextPageToken

string

Token identyfikujący następną stronę wyników do zwrócenia. Jeśli jest puste, nie ma dostępnych dalszych wyników.

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 dotyczącym autoryzacji.