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, เก็บถาวร, จัดหา, ถูกปฏิเสธ
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

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