Method: userProfiles.guardians.list

요청한 사용자에게 보기가 허용된 보호자 목록(요청과 일치하는 보호자로 제한)을 반환합니다.

요청한 사용자가 보호자를 볼 수 있는 학생의 보호자를 나열하려면 학생 ID에 리터럴 문자 -를 사용합니다.

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

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

HTTP 요청

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

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

경로 매개변수

매개변수
studentId

string

보호자가 연결된 학생별로 결과를 필터링합니다. 식별자는 다음 중 하나일 수 있습니다.

  • 사용자의 숫자 식별자입니다.
  • 사용자의 이메일 주소
  • 요청하는 사용자를 나타내는 문자열 리터럴 "me"
  • 문자열 리터럴 "-": 요청하는 사용자에게 보기 액세스 권한이 있는 모든 학생에 대해 결과가 반환되어야 함을 나타냅니다.

쿼리 매개변수

매개변수
invitedEmailAddress

string

원래 초대가 전송된 이메일 주소로 결과를 필터링하면 이 보호자 링크가 표시됩니다. 이 필터는 도메인 관리자만 사용할 수 있습니다.
pageToken

string

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

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

integer

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

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

요청 본문

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

응답 본문

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

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

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

object (Guardian)

요청에 지정된 기준을 충족하는 이 결과 페이지의 보호자입니다.
nextPageToken

string

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

승인 범위

다음 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

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