Method: userProfiles.guardians.list

Trả về danh sách người giám hộ mà người dùng yêu cầu được phép xem, chỉ 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ộ cho 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ã học 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 của người giám hộ cho học viên đó, nếu bạn chỉ định "-" làm studentId và người dùng không phải là quản trị viên miền, nếu bạn không bật người giám hộ cho miền có liên quan, nếu người dùng không phải là quản trị viên miền đặt bộ lọc invitedEmailAddress hoặc đối với các lỗi truy cập khác.
  • INVALID_ARGUMENT nếu bạn chỉ định studentId nhưng không nhận dạng được định dạng của studentId (đây không phải là địa chỉ email, cũng không phải là studentId từ API, cũng không phải là chuỗi ký tự me). Cũng có thể được trả về nếu bạn cung cấp pageToken không hợp lệ.
  • NOT_FOUND nếu bạn chỉ định studentId và định dạng của tệp đó có thể được nhận dạng, nhưng Lớp học không có bản ghi về 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

Thông số
studentId

string

Lọc kết quả theo học viên mà người giám hộ được liên kết. 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
  • chuỗi cố định "me", cho biết người dùng yêu cầu
  • chuỗi cố định "-", cho biết kết quả sẽ được trả về 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

Thông số
invitedEmailAddress

string

Lọc kết quả theo địa chỉ email mà lời mời ban đầu được gửi đến, dẫn đến đường liên kết của 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 hệt với yêu cầu đã tạo ra mã thông báo này.
pageSize

integer

Số lượng mục tối đa cần trả về. 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 hơn số kết quả được 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

Nội dung 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
}
Trường
guardians[]

object (Guardian)

Những người giám hộ trên trang kết quả này đã đáp ứng các tiêu chí được chỉ định 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, bạn sẽ không nhận được kết quả nào khác.

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.