Method: userProfiles.guardians.list

Trả về danh sách những người giám hộ mà người dùng yêu cầu được phép xem, được giới hạn ở những người giám hộ khớp với yêu cầu.

Để liệt kê người giám hộ của bất kỳ học viên nào mà người dùng yêu cầu có thể xem người giám hộ, hãy sử dụng ký tự cố định - cho mã nhận dạng sinh viên.

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

  • PERMISSION_DENIED nếu bạn chỉ định studentId và 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 đó, nếu "-" được chỉ định là studentId và người dùng không phải là quản trị viên miền, nếu người giám hộ không được bật cho miền có liên quan, nếu bộ lọc invitedEmailAddress do một người dùng không phải là quản trị viên miền hoặc do các lỗi truy cập khác.
  • INVALID_ARGUMENT nếu studentId được chỉ định nhưng không nhận dạng được định dạng của nó (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). Cũng có thể được trả về nếu pageToken không hợp lệ được cung cấp.
  • NOT_FOUND nếu bạn chỉ định studentId và nhận dạng định dạng của học viên đó, nhưng Lớp học không lưu hồ sơ của học viên đó.

Yêu cầu HTTP

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

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

Tham số đường dẫn

Các tham số
studentId

string

Lọc kết quả theo học viên có liên kết với người giám hộ. Giá trị nhận dạng có thể là 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
  • giá trị cố định kiểu chuỗi "-", cho biết rằng cần phải trả về kết quả cho tất cả học viên mà người dùng yêu cầu có quyền xem.

Tham số truy vấn

Các tham số
invitedEmailAddress

string

Lọc kết quả theo địa chỉ email nhận lời mời ban đầu, dẫn đến đường liên kết đến người giám hộ này. Chỉ quản trị viên miền mới có thể sử dụng bộ lọc này.
pageToken

string

Giá trị nextPageToken được trả về từ lệnh gọi list trước đó, cho biết rằng trang kết quả tiếp theo sẽ được trả về.

Yêu cầu list phải giống với yêu cầu đã dẫn đến mã thông báo này.
pageSize

integer

Số lượng mục tối đa cần trả lại. Giá trị 0 hoặc không xác định cho biết máy chủ có thể chỉ định giá trị tối đa.

Máy chủ có thể trả về ít kết quả hơn số kết quả đã chỉ định.

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

Phản hồi khi liệt kê người giám hộ.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "guardians": [
    {
      object (Guardian)
    }
  ],
  "nextPageToken": string
}
Các trường
guardians[]

object (Guardian)

Người giám hộ trên trang kết quả này đáp ứng tiêu chí được nêu trong yêu cầu.
nextPageToken

string

Mã thông báo xác định trang kết quả tiếp theo cần trả về. Nếu trống, sẽ không có thêm kết quả nào.

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.