Method: userProfiles.guardians.get

특정 보호자를 반환합니다.

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

  • 요청한 사용자에게 제공된 studentId와 일치하는 사용자가 없는 경우, 요청하는 사용자에게 studentId에서 식별된 학생의 보호자 정보를 볼 권한이 없는 경우, 해당 도메인에 보호자가 사용 설정되어 있지 않은 경우 또는 기타 액세스 오류가 있는 경우 PERMISSION_DENIED입니다.
  • studentId가 지정되었지만 형식을 인식할 수 없는 경우 (이메일 주소, API의 studentId, 리터럴 문자열 me도 아닌 경우) INVALID_ARGUMENT입니다.
  • 요청하는 사용자가 요청된 studentId의 보호자를 볼 수 있도록 허용되지만 제공된 guardianId과 일치하는 해당 학생의 Guardian 레코드가 없는 경우 NOT_FOUND

HTTP 요청

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

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

경로 매개변수

매개변수
studentId

string

보호자를 요청 중인 학생입니다. 다음 필드 중 하나는 사용해야 합니다.

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

string

Guardian의 id 필드.

요청 본문

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

응답 본문

성공한 경우 응답 본문에 Guardian의 인스턴스가 포함됩니다.

승인 범위

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

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

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