Method: courses.list

แสดงรายการหลักสูตรที่ผู้ใช้ที่ส่งคำขอได้รับอนุญาตให้ดู โดยจำกัดไว้เฉพาะหลักสูตรที่ตรงกับคำขอ ระบบจะจัดเรียงหลักสูตรที่แสดงตามเวลาที่สร้าง โดยหลักสูตรที่สร้างล่าสุดจะแสดงก่อน

วิธีการนี้จะแสดงรหัสข้อผิดพลาดต่อไปนี้

  • PERMISSION_DENIED สำหรับข้อผิดพลาดในการเข้าถึง
  • INVALID_ARGUMENT หากอาร์กิวเมนต์การค้นหามีรูปแบบไม่ถูกต้อง
  • NOT_FOUND หากไม่มีผู้ใช้ที่ระบุไว้ในอาร์กิวเมนต์การค้นหา

คำขอ HTTP

GET https://classroom.googleapis.com/v1/courses

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์การค้นหา

พารามิเตอร์
studentId

string

จำกัดหลักสูตรที่แสดงผลไว้เฉพาะหลักสูตรที่มีนักเรียนที่มีตัวระบุที่ระบุ ตัวระบุอาจเป็นค่าใดค่าหนึ่งต่อไปนี้

  • ตัวระบุตัวเลขของผู้ใช้
  • อีเมลของผู้ใช้
  • สตริงตามตัวอักษร "me" ที่ระบุผู้ใช้ที่ส่งคำขอ
teacherId

string

จำกัดหลักสูตรที่แสดงผลไว้เฉพาะหลักสูตรที่มีครูซึ่งมีตัวระบุที่ระบุ ตัวระบุอาจเป็นค่าใดค่าหนึ่งต่อไปนี้

  • ตัวระบุตัวเลขของผู้ใช้
  • อีเมลของผู้ใช้
  • สตริงตามตัวอักษร "me" ที่ระบุผู้ใช้ที่ส่งคำขอ
courseStates[]

enum (CourseState)

จำกัดหลักสูตรที่แสดงผลไว้เฉพาะหลักสูตรที่อยู่ในสถานะใดสถานะหนึ่งตามที่ระบุ ค่าเริ่มต้นคือ ACTIVE, ARCHIVED, PROVISIONED, DECLINED
pageSize

integer

จำนวนรายการสูงสุดที่จะแสดง 0 หรือไม่ระบุหมายความว่าเซิร์ฟเวอร์อาจกำหนดค่าสูงสุด

เซิร์ฟเวอร์อาจแสดงผลลัพธ์น้อยกว่าจำนวนที่ระบุ
pageToken

string

ค่า nextPageToken ที่แสดงผลจากการเรียก list ก่อนหน้า ซึ่งระบุว่าควรแสดงผลหน้าผลการค้นหาถัดไป

คําขอ list ต้องเหมือนกับคําขอที่ทําให้เกิดโทเค็นนี้

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

การตอบกลับเมื่อแสดงข้อมูลหลักสูตร

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "courses": [
    {
      object (Course)
    }
  ],
  "nextPageToken": string
}
ช่อง
courses[]

object (Course)

หลักสูตรที่ตรงกับคำขอรายการ
nextPageToken

string

โทเค็นที่ระบุหน้าถัดไปของผลการค้นหาที่จะแสดง หากช่องนี้ว่างเปล่า แสดงว่าไม่มีผลการค้นหาเพิ่มเติม

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์