Method: invitations.list

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

Lưu ý: Phải cung cấp ít nhất một trong hai giá trị 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:

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

Tham số
userId

string

Hạn chế lời mời được trả về cho những lời mời dành cho người dùng cụ thể. Giá trị nhận dạng có thể là một trong những giá trị sau:

  • giá trị nhận dạng dưới dạng số cho 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
courseId

string

Hạn chế lời mời được trả về cho những người tham gia một khoá học có giá trị nhận dạng được chỉ định.
pageSize

integer

Số mục tối đa cần trả về. Giá trị mặc định là 500 nếu bạn không chỉ định hoặc 0.

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

string

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

Nếu không, yêu cầu list phải giống với yêu cầu đã tạo ra mã thông báo này.

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ê các lời mời.

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 (Invitation)
    }
  ],
  "nextPageToken": string
}
Trường
invitations[]

object (Invitation)

Lời mời khớp với yêu cầu danh sách.
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, 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.