Method: courses.list

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

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

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

คำขอ HTTP

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

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

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

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

string

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

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

หากระบุ teacherId แล้ว จะต้องว่างเปล่า
teacherId

string

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

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

หากระบุ studentId แล้ว จะต้องว่างเปล่า
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

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