Method: userProfiles.guardianInvitations.list

요청하는 사용자가 볼 수 있는 보호자 초대 목록을 제공된 매개변수로 필터링하여 반환합니다.

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

  • studentId가 지정되었고 요청하는 사용자가 해당 학생의 보호자 초대를 볼 수 없는 경우, "-"가 studentId로 지정되었고 사용자가 도메인 관리자가 아닌 경우, 해당 도메인에 보호자가 사용 설정되지 않은 경우 또는 기타 액세스 오류의 경우 PERMISSION_DENIED입니다.
  • studentId가 지정되었지만 형식을 인식할 수 없는 경우 (이메일 주소, API의 studentId, 리터럴 문자열 me이 아님) INVALID_ARGUMENT이 반환됩니다. 잘못된 pageToken 또는 state가 제공된 경우에도 반환될 수 있습니다.
  • NOT_FOUND: studentId이 지정되고 형식을 인식할 수 있지만 클래스룸에 해당 학생에 대한 기록이 없는 경우

HTTP 요청

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations

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

경로 매개변수

매개변수
studentId

string

보호자 초대를 반환할 학생의 ID입니다. 식별자는 다음 중 하나일 수 있습니다.

  • 사용자의 숫자 식별자
  • 사용자의 이메일 주소
  • 요청하는 사용자를 나타내는 문자열 리터럴 "me"
  • 문자열 리터럴 "-": 요청 사용자가 보호자 초대를 볼 수 있는 모든 학생의 결과를 반환해야 함을 나타냅니다.

쿼리 매개변수

매개변수
invitedEmailAddress

string

지정된 경우 지정된 invitedEmailAddress가 있는 결과만 반환됩니다.
states[]

enum (GuardianInvitationState)

지정된 경우 지정된 state 값이 있는 결과만 반환됩니다. 그렇지 않으면 state이 PENDING인 결과가 반환됩니다.
pageToken

string

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

그렇지 않으면 list 요청이 이 토큰을 생성한 요청과 동일해야 합니다.
pageSize

integer

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

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

요청 본문

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

응답 본문

보호자 초대를 나열할 때의 응답입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

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

object (GuardianInvitation)

목록 요청과 일치하는 보호자 초대
nextPageToken

string

반환할 다음 결과 페이지를 식별하는 토큰입니다. 비어 있으면 더 이상 결과를 사용할 수 없습니다.

승인 범위

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

  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

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