Công cụ: list_courses
Liệt kê các khoá học của người dùng cùng với thông tin chi tiết (phần, phòng, môn học, cấp lớp, nội dung mô tả, mục tiêu học tập, trạng thái và vai trò của người dùng). Sử dụng phương thức này làm điểm truy cập chính để khám phá các khoá học và truy xuất mã nhận dạng của khoá học. Các khoá học thường có cùng tên, vì vậy, hãy sử dụng phần để phân biệt các khoá học. Chỉ trả về các khoá học ĐANG HOẠT ĐỘNG, trừ phi bạn đặt courseState (ví dụ: ĐÃ LƯU TRỮ).
Để liên kết người dùng với một khoá học trong ứng dụng web Lớp học, hãy sử dụng https://classroom.google.com/c/{course_id} (bảng tin) hoặc https://classroom.google.com/w/{course_id}/t/all (trang Bài tập trên lớp). Sử dụng mã nhận dạng chính xác như được trả về; đừng bao giờ đoán hoặc sửa đổi mã nhận dạng.
Mã mẫu sau đây cho biết cách sử dụng curl để gọi công cụ MCP list_courses.
| Yêu cầu Curl |
|---|
curl --location 'https://classroommcp.googleapis.com/mcp/v1' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "list_courses", "arguments": { // Provide these details according to the MCP tool specification. } }, "jsonrpc": "2.0", "id": 1 }' |
Giản đồ đầu vào
Yêu cầu liệt kê các khoá học.
ListCoursesRequest
| Biểu diễn dưới dạng JSON |
|---|
{ "courseState": enum ( |
| Trường | |
|---|---|
courseState |
Không bắt buộc. Lọc theo trạng thái khoá học. Giá trị mặc định là |
createdDateRange |
Không bắt buộc. Lọc theo phạm vi ngày tạo. |
timeZone |
Bắt buộc. Múi giờ IANA của người dùng (ví dụ: |
titleContains |
Không bắt buộc. Lọc tiêu đề theo chuỗi con không phân biệt chữ hoa chữ thường. |
pageSize |
Không bắt buộc. Kiểm soát kích thước trang. Mặc định là 10; tối đa là 50. |
pageToken |
Không bắt buộc. Mã thông báo để phân trang. |
DateRange
| Biểu diễn dưới dạng JSON |
|---|
{ "startDate": string, "endDate": string } |
| Trường | |
|---|---|
startDate |
Điểm bắt đầu của phạm vi (bao gồm cả điểm này) (định dạng: YYYY-MM-DD). |
endDate |
Ngày kết thúc của phạm vi (định dạng: YYYY-MM-DD). |
Tiểu bang
Trạng thái của khoá học.
| Enum | |
|---|---|
STATE_UNSPECIFIED |
Trạng thái chưa xác định. |
ACTIVE |
Trạng thái đang hoạt động. |
ARCHIVED |
Trạng thái đã lưu trữ. |
PROVISIONED |
Trạng thái đã cấp phép. |
Giản đồ đầu ra
Phản hồi cho danh sách khoá học.
ListCoursesResponse
| Biểu diễn dưới dạng JSON |
|---|
{
"courses": [
{
object ( |
| Trường | |
|---|---|
courses[] |
Danh sách khoá học. |
nextPageToken |
Mã thông báo trang tiếp theo. |
Khoá học
| Biểu diễn dưới dạng JSON |
|---|
{ "id": string, "title": string, "role": enum ( |
| Trường | |
|---|---|
id |
Giá trị nhận dạng. Giá trị nhận dạng cho khoá học này. |
title |
Tiêu đề của khoá học. |
role |
Vai trò của người dùng trong khoá học này. |
creationDate |
Ngày tạo khoá học (định dạng: YYYY-MM-DD). Để trống nếu không biết ngày tạo. |
state |
Chỉ có đầu ra. Trạng thái của khoá học. |
section |
Không bắt buộc. Phần của khoá học. |
room |
Không bắt buộc. Phòng của khoá học. |
subject |
Không bắt buộc. Môn học của khoá học. |
gradeLevels |
Không bắt buộc. Cấp lớp của khoá học. |
description |
Không bắt buộc. Nội dung mô tả khoá học. |
learningGoals[] |
Chỉ có đầu ra. Mục tiêu học tập được đính kèm vào khoá học này. |
LearningGoal
| Biểu diễn dưới dạng JSON |
|---|
{
"id": string,
"type": enum ( |
| Trường | |
|---|---|
id |
Chỉ có đầu ra. Mã nhận dạng của mục tiêu học tập. Để đính kèm một tiêu chuẩn, hãy sử dụng |
type |
Chỉ có đầu ra. Loại mục tiêu học tập. |
standardCode |
Chỉ có đầu ra. Mã tiêu chuẩn (ví dụ: "NY-2.NBT.4"). Chỉ được điền sẵn cho tiêu chuẩn. |
title |
Chỉ có đầu ra. Nội dung mô tả tuyên bố cho các tiêu chuẩn hoặc tiêu đề mà con người có thể đọc được cho các kỹ năng. |
documentTitle |
Chỉ có đầu ra. Tên tài liệu chương trình học. Chỉ được điền sẵn cho tiêu chuẩn. |
Vai trò
Vai trò của người dùng trong một khoá học.
| Enum | |
|---|---|
ROLE_UNSPECIFIED |
Vai trò không xác định. |
TEACHER |
Vai trò giáo viên. |
COTEACHER |
Vai trò của người cùng dạy. |
STUDENT |
Vai trò của học viên. |
INVITED_OR_INACTIVE |
Vai trò được mời hoặc không hoạt động. |
Tiểu bang
Trạng thái của khoá học.
| Enum | |
|---|---|
STATE_UNSPECIFIED |
Trạng thái chưa xác định. |
ACTIVE |
Trạng thái đang hoạt động. |
ARCHIVED |
Trạng thái đã lưu trữ. |
PROVISIONED |
Trạng thái đã cấp phép. |
Loại
Loại mục tiêu học tập.
| Enum | |
|---|---|
TYPE_UNSPECIFIED |
Loại mục tiêu học tập không xác định. |
STANDARD |
Một tiêu chuẩn học tập trong chương trình học. |
SKILL |
Một kỹ năng đại diện cho một khái niệm hoặc năng lực giáo dục. Chỉ giáo viên mới có thể thêm hoặc xoá kỹ năng trong Lớp học. |
Chú thích về công cụ
Chú thích về công cụ được gửi đến ứng dụng MCP để mô tả rủi ro cơ bản của một công cụ nhất định. Hầu hết ứng dụng đều coi những gợi ý này là không đáng tin cậy, nhưng có thể dùng chúng để quyết định thời điểm gửi lời nhắc xác nhận cho người dùng.
Cùng với chuỗi tiêu đề, các gợi ý boolean sau đây được xác định như sau:
readOnlyHint: Nếu đúng, công cụ sẽ không sửa đổi môi trường của nó. Mặc định: false.destructiveHint: Nếu đúng, thì công cụ có thể thực hiện các hành động có tính huỷ diệt. Nếu là false, thì công cụ chỉ có thể thực hiện các hành động bổ sung. Mặc định: true.idempotentHint: Nếu đúng, thì việc gọi công cụ nhiều lần với cùng một đối số sẽ không có thêm hiệu ứng nào đối với môi trường của công cụ đó. Mặc định: false.openWorldHint: Nếu đúng, thì công cụ này có thể tương tác với "thế giới mở" của các thực thể bên ngoài. Nếu là false, thì công cụ chỉ có thể tương tác với các thực thể nội bộ. Ví dụ: công cụ tìm kiếm trên web sẽ là công cụ thế giới mở, còn công cụ ghi nhớ sẽ không phải là công cụ thế giới mở.
Gợi ý về thao tác huỷ bỏ: ❌ | Gợi ý về thao tác không thay đổi giá trị: ✅ | Gợi ý về thao tác chỉ đọc: ✅ | Gợi ý về thao tác thế giới mở: ❌
Phạm vi cấp phép
Yêu cầu một trong các phạm vi OAuth sau:
https://www.googleapis.com/auth/classroom.courses.readonlyhttps://www.googleapis.com/auth/classroom.rosters.readonly