Method: userProfiles.guardianInvitations.create

보호자 초대를 만들고 보호자에게 학생의 보호자임을 확인해 달라는 이메일을 보냅니다.

보호자가 초대를 수락하면 state이 COMPLETED로 변경되고 보호자 알림이 수신되기 시작합니다. 활성 보호자를 나타내는 Guardian 리소스도 생성됩니다.

요청 객체에 studentId 및 invitedEmailAddress 필드가 설정되어 있어야 합니다. 이러한 필드를 설정하지 않거나 요청에 다른 필드를 설정하면 오류가 발생합니다.

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

  • PERMISSION_DENIED: 현재 사용자에게 보호자를 관리할 권한이 없거나, 해당 보호자가 해당 학생에 대한 요청을 이미 너무 많이 거부했거나, 해당 도메인에 보호자가 사용 설정되어 있지 않거나, 기타 액세스 오류가 있는 경우
  • RESOURCE_EXHAUSTED: 학생 또는 보호자가 보호자 링크 한도를 초과한 경우
  • 보호자 이메일 주소가 유효하지 않거나 (예: 너무 긴 경우) 제공된 학생 ID 형식을 인식할 수 없는 경우 (이메일 주소가 아니거나 이 API의 userId가 아닌 경우) INVALID_ARGUMENT입니다. 읽기 전용 필드가 설정되거나 state 필드가 PENDING이 아닌 값으로 설정된 경우에도 이 오류가 반환됩니다.
  • NOT_FOUND: 제공된 학생 ID가 유효한 학생 ID이지만 클래스룸에 해당 학생의 기록이 없는 경우
  • ALREADY_EXISTS: 학생에 대한 보호자 초대가 이미 대기 중이고 제공된 invitedEmailAddress가 있거나 제공된 invitedEmailAddress가 이 사용자의 기존 Guardian의 Google 계정과 일치하는 경우

HTTP 요청

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

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

경로 매개변수

매개변수
guardianInvitation.studentId

string

학생의 ID (표준 형식)

요청 본문

요청 본문에 GuardianInvitation의 인스턴스가 포함됩니다.

응답 본문

성공한 경우 응답 본문에 새로 생성된 GuardianInvitation의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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