Method: userProfiles.guardians.get

Trả về một người giám hộ cụ thể.

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

  • PERMISSION_DENIED nếu không có người dùng nào khớp với studentId mà bạn cung cấp sẽ hiển thị cho người dùng yêu cầu, nếu người dùng yêu cầu không được phép xem thông tin về người giám hộ của học viên do studentId xác định, nếu người giám hộ không được bật cho miền liên quan hoặc vì các lỗi truy cập khác.
  • INVALID_ARGUMENT nếu studentId được chỉ định nhưng định dạng của nó không nhận dạng được (không phải địa chỉ email, cũng không phải studentId từ API, cũng không phải chuỗi ký tự me).
  • NOT_FOUND nếu người dùng yêu cầu được phép xem người giám hộ cho studentId được yêu cầu, nhưng không có bản ghi Guardian nào cho học viên đó khớp với guardianId được cung cấp.

Yêu cầu HTTP

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

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

Tham số đường dẫn

Các tham số
studentId

string

Học viên có người giám hộ đang được yêu cầu. Một trong những giá trị sau:

  • giá trị nhận dạng dạng số của người dùng
  • địa chỉ email của người dùng
  • giá trị cố định kiểu chuỗi "me", cho biết người dùng đưa ra yêu cầu
guardianId

string

Trường id từ Guardian.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

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 phiên bản của Guardian.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • 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

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