แสดงรายการหลักสูตรที่อนุญาตให้ผู้ใช้ที่ส่งคำขอดูได้ โดยจำกัดเฉพาะหลักสูตรที่ตรงกับคำขอ หลักสูตรที่แสดงจะเรียงลำดับตามเวลาที่สร้าง โดยหลักสูตรที่สร้างล่าสุดจะอยู่ก่อน
เมธอดนี้จะแสดงรหัสข้อผิดพลาดต่อไปนี้
PERMISSION_DENIED
เพื่อดูข้อผิดพลาดในการเข้าถึงINVALID_ARGUMENT
หากอาร์กิวเมนต์การค้นหามีรูปแบบไม่ถูกต้องNOT_FOUND
ถ้าไม่มีผู้ใช้ที่ระบุในอาร์กิวเมนต์การค้นหา
คำขอ HTTP
GET https://classroom.googleapis.com/v1/courses
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
studentId |
จำกัดหลักสูตรที่ส่งคืนให้นักเรียนที่มีนักเรียนซึ่งมีตัวระบุที่ระบุไว้เท่านั้น ตัวระบุอาจเป็นอย่างใดอย่างหนึ่งต่อไปนี้
|
teacherId |
จำกัดหลักสูตรที่แสดงผลสำหรับผู้ที่มีครูซึ่งมีตัวระบุที่ระบุ ตัวระบุอาจเป็นอย่างใดอย่างหนึ่งต่อไปนี้
|
courseStates[] |
จำกัดหลักสูตรที่แสดงผลเฉพาะหลักสูตรที่อยู่ในสถานะที่ระบุ ค่าเริ่มต้นคือ ACTIVE, ARCHIVED, PROVISIONED, DECLINED |
pageSize |
จำนวนรายการสูงสุดที่จะส่งคืน ค่าศูนย์หรือไม่ได้ระบุหมายความว่าเซิร์ฟเวอร์สามารถกำหนดค่าสูงสุดได้ เซิร์ฟเวอร์อาจส่งคืนผลลัพธ์น้อยกว่าจำนวนที่ระบุ |
pageToken |
ค่า คำขอ |
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
ตอบกลับเมื่อแสดงรายการหลักสูตร
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"courses": [
{
object ( |
ช่อง | |
---|---|
courses[] |
หลักสูตรที่ตรงกับคำขอของรายการ |
nextPageToken |
โทเค็นที่ระบุหน้าผลลัพธ์ถัดไปที่จะแสดง หากว่างเปล่า จะไม่มีผลลัพธ์เพิ่มเติม |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้
https://www.googleapis.com/auth/classroom.courses
https://www.googleapis.com/auth/classroom.courses.readonly
สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์