Method: courses.courseWork.getAddOnContext

Lấy siêu dữ liệu cho các tiện ích bổ sung của Lớp học trong ngữ cảnh của một bài đăng cụ thể.

Để duy trì tính toàn vẹn của mô hình quyền và dữ liệu của riêng mình, tiện ích bổ sung phải gọi phương thức này để xác thực các tham số truy vấn và vai trò của người dùng yêu cầu bất cứ khi nào tiện ích bổ sung được mở trong iframe.

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

  • PERMISSION_DENIED đối với lỗi truy cập.
  • INVALID_ARGUMENT nếu yêu cầu không đúng định dạng.
  • NOT_FOUND nếu một trong các tài nguyên được xác định không tồn tại.

Yêu cầu HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnContext

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

Tham số đường dẫn

Tham số
courseId

string

Bắt buộc. Giá trị nhận dạng của khoá học.
itemId

string

Giá trị nhận dạng của Announcement, CourseWork hoặc CourseWorkMaterial trong đó tệp đính kèm được đính kèm. Đây là trường bắt buộc, nhưng không được đánh dấu là bắt buộc trong khi chúng tôi di chuyển từ postId.

Tham số truy vấn

Tham số
addOnToken

string

Không bắt buộc. Mã thông báo uỷ quyền cho yêu cầu.

Mã thông báo được truyền dưới dạng tham số truy vấn khi người dùng được chuyển hướng từ Lớp học sang URL của tiện ích bổ sung.

Mã thông báo uỷ quyền là bắt buộc khi không có điều kiện nào sau đây là đúng:

  • Tiện ích bổ sung có tệp đính kèm trên bài đăng.
  • Dự án nhà phát triển đưa ra yêu cầu là chính dự án đã tạo bài đăng.
attachmentId

string

Không bắt buộc. Giá trị nhận dạng của tệp đính kèm. Trường này là bắt buộc đối với tất cả các yêu cầu, ngoại trừ khi người dùng đang ở trong iframe Khám phá tệp đính kèm.

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ếu thành công, nội dung phản hồi sẽ chứa một phiên bản của AddOnContext.

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.addons.student
  • https://www.googleapis.com/auth/classroom.addons.teacher

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.