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

반환할 최대 항목 수입니다. 0 또는 지정되지 않은 경우 서버에서 최대값을 할당할 수 있음을 나타냅니다.

서버에서 지정된 수보다 적은 결과를 반환할 수 있습니다.
pageToken

string

이전 list 호출에서 반환된 nextPageToken 값으로, 후속 결과 페이지를 반환해야 함을 나타냅니다.

그렇지 않으면 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

자세한 내용은 승인 가이드를 참고하세요.