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, chỉ giới hạn ở những lời mời khớ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 hai thuộc tính 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ế các lời mời được trả về 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:

  • 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
courseId

string

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

integer

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

Máy chủ có thể trả về ít hơn số kết quả được chỉ định.
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.

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 đăng 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)

Những lời mời khớp với yêu cầu về 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, 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.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.