Trả về danh sách lời mời mà người dùng yêu cầu được phép xem, được giới hạn ở những lời mời phù hợp với yêu cầu danh sách.
Lưu ý: Bạn phải cung cấp ít nhất một trong số userId
hoặc courseId
. Bạn có thể cung cấp cả hai trường.
Phương thức này trả về các mã lỗi sau:
PERMISSION_DENIED
do lỗi truy cập.
Yêu cầu HTTP
GET https://classroom.googleapis.com/v1/invitations
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số truy vấn
Các tham số | |
---|---|
userId |
Hạn chế các lời mời được trả về đối với các lời mời đó cho một người dùng cụ thể. Giá trị nhận dạng có thể là một trong những giá trị sau:
|
courseId |
Hạn chế các lời mời tham gia khoá học được trả về bằng giá trị nhận dạng đã chỉ định. |
pageSize |
Số lượng mục tối đa cần trả lại. Giá trị mặc định là 500 nếu không được chỉ định hoặc là Máy chủ có thể trả về ít kết quả hơn số kết quả đã chỉ định. |
pageToken |
Giá trị Yêu cầu |
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 gửi lời mời đăng danh sách sản phẩm.
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 |
---|
{
"invitations": [
{
object ( |
Các trường | |
---|---|
invitations[] |
Lời mời khớp với yêu cầu danh sách. |
nextPageToken |
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.rosters
https://www.googleapis.com/auth/classroom.rosters.readonly
Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.