Method: userProfiles.guardianInvitations.create

Tạo lời mời dành cho người giám hộ rồi gửi email cho người giám hộ đó để yêu cầu họ xác nhận rằng họ là người giám hộ của học viên.

Sau khi người giám hộ chấp nhận lời mời, state của họ sẽ đổi thành COMPLETED và họ sẽ bắt đầu nhận được thông báo dành cho người giám hộ. Một tài nguyên Guardian cũng sẽ được tạo để đại diện cho người giám hộ đang hoạt động.

Đối tượng yêu cầu phải được đặt các trường studentId và invitedEmailAddress. Việc không thiết lập các trường này hoặc thiết lập bất kỳ trường nào khác trong yêu cầu sẽ dẫn đến lỗi.

Phương thức này trả về các mã lỗi sau:

  • PERMISSION_DENIED nếu người dùng hiện tại không có quyền quản lý người giám hộ, nếu người giám hộ được đề cập đã từ chối quá nhiều yêu cầu đối với học viên đó, nếu người giám hộ chưa được bật cho miền có liên quan hoặc vì các lỗi truy cập khác.
  • RESOURCE_EXHAUSTED nếu học viên hoặc người giám hộ đã vượt quá giới hạn số lượng đường liên kết dành cho người giám hộ.
  • INVALID_ARGUMENT nếu địa chỉ email của người giám hộ không hợp lệ (ví dụ: nếu quá dài) hoặc nếu hệ thống không nhận dạng được định dạng của thẻ sinh viên đã cung cấp (không phải địa chỉ email hay userId từ API này). Lỗi này cũng sẽ được trả về nếu bạn đặt các trường chỉ có thể đọc hoặc nếu trường state được đặt thành một giá trị không phải là PENDING.
  • NOT_FOUND nếu thẻ học viên mà bạn cung cấp là thẻ sinh viên hợp lệ, nhưng Lớp học không có hồ sơ của học viên đó.
  • ALREADY_EXISTS nếu có lời mời là người giám hộ đang chờ xử lý đối với học viên và invitedEmailAddress được cung cấp, hoặc nếu invitedEmailAddress được cung cấp khớp với Tài khoản Google của Guardian hiện có của người dùng này.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Các tham số
guardianInvitation.studentId

string

Thẻ sinh viên (ở định dạng chuẩn)

Nội dung yêu cầu

Nội dung yêu cầu chứa một bản sao của GuardianInvitation.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một thực thể mới được tạo của GuardianInvitation.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.