Method: courses.courseWork.getAddOnContext

Lấy siêu dữ liệu về các tiện ích bổ sung cho Google 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 dữ liệu và quyền, tiện ích bổ sung sẽ gọi hàm này để xác thự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 để biết 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 đã 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

Thông 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 mà tệp đính kèm sẽ được đính kèm. Trường này là bắt buộc, nhưng không được đánh dấu như vậy trong khi chúng ta di chuyển từ postId.

Tham số truy vấn

Thông số
addOnToken

string

Không bắt buộc. Mã thông báo cho phép yêu cầu.

Mã thông báo này được chuyể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 đến 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ó trường hợp nào sau đây đúng:

  • Tiện ích bổ sung này có tệp đính kèm trên bài đăng.
  • Dự án của nhà phát triển đưa ra yêu cầu chính là 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 cho tất cả các yêu cầu trừ khi người dùng đang ở iframe của tính năng 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.