요청하는 사용자에게 보기가 허용된 초대 목록 중 목록 요청과 일치하는 것으로 제한된 초대 목록을 반환합니다.
참고: 하나 이상의 userId
또는 courseId
를 제공해야 합니다. 두 필드를 모두 입력할 수 있습니다.
이 메서드는 다음 오류 코드를 반환합니다.
- 액세스 오류:
PERMISSION_DENIED
HTTP 요청
GET https://classroom.googleapis.com/v1/invitations
URL은 gRPC 트랜스코딩 구문을 사용합니다.
쿼리 매개변수
매개변수 | |
---|---|
userId |
반환되는 초대를 특정 사용자의 초대로 제한합니다. 식별자는 다음 중 하나일 수 있습니다.
|
courseId |
반환되는 초대를 지정된 식별자가 있는 수업의 초대로 제한합니다. |
pageSize |
반환할 최대 항목 수입니다. 지정되지 않은 경우 기본값은 500이거나 서버가 지정된 수보다 적은 수의 결과를 반환할 수 있습니다. |
pageToken |
이전 그 외에 |
요청 본문
요청 본문은 비어 있어야 합니다.
응답 본문
초대 나열 시 응답
성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.
JSON 표현 |
---|
{
"invitations": [
{
object ( |
필드 | |
---|---|
invitations[] |
목록 요청과 일치하는 초대입니다. |
nextPageToken |
반환할 결과의 다음 페이지를 식별하는 토큰입니다. 비어 있으면 더 이상 결과를 사용할 수 없습니다. |
승인 범위
다음 OAuth 범위 중 하나가 필요합니다.
https://www.googleapis.com/auth/classroom.rosters
https://www.googleapis.com/auth/classroom.rosters.readonly
자세한 내용은 승인 가이드를 참고하세요.