Method: invitations.list

요청한 사용자가 볼 수 있는 초대 목록(목록 요청과 일치하는 초대로 제한)을 반환합니다.

참고: userId 또는 courseId 중 하나 이상을 제공해야 합니다. 두 필드 모두 입력할 수 있습니다.

이 메서드는 다음 오류 코드를 반환합니다.

HTTP 요청

GET https://classroom.googleapis.com/v1/invitations

URL은 gRPC 트랜스코딩 구문을 사용합니다.

쿼리 매개변수

매개변수
userId

string

반환된 초대를 특정 사용자의 초대로 제한합니다. 식별자는 다음 중 하나일 수 있습니다.

  • 사용자의 숫자 식별자입니다.
  • 사용자의 이메일 주소
  • 요청하는 사용자를 나타내는 문자열 리터럴 "me"
courseId

string

반환된 초대를 지정된 식별자가 있는 과정의 초대로 제한합니다.
pageSize

integer

반환할 최대 항목 수입니다. 기본값은 지정되지 않은 경우 500이고, 그렇지 않은 경우 0입니다.

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

string

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

그 외의 list 요청은 이 토큰을 생성한 요청과 동일해야 합니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

초대 나열 시 응답입니다.

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "invitations": [
    {
      object (Invitation)
    }
  ],
  "nextPageToken": string
}
필드
invitations[]

object (Invitation)

목록 요청과 일치하는 초대입니다.
nextPageToken

string

반환할 다음 결과 페이지를 식별하는 토큰입니다. 비어 있으면 추가 결과가 없습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

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