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)

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

integer

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

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

string

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

คำขอ list ต้องเหมือนกับคำขอที่ทำให้เกิดโทเค็นนี้ในส่วนอื่นๆ
previewVersion

enum (PreviewVersion)

ไม่บังคับ เวอร์ชันตัวอย่างของ API คุณต้องตั้งค่านี้เพื่อเข้าถึงความสามารถใหม่ของ API ที่พร้อมให้บริการแก่นักพัฒนาแอปในโปรแกรมทดลองใช้

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

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

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

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

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

การแสดง 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

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