Method: courses.courseWork.list

แสดงรายการงานในหลักสูตรที่ผู้ขอได้รับอนุญาตให้ดู

นักเรียนในหลักสูตรจะดูได้เฉพาะPUBLISHEDงานในหลักสูตร ครูผู้สอนและผู้ดูแลระบบโดเมนจะดูงานในหลักสูตรทั้งหมดได้

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

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

คำขอ HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork

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

พารามิเตอร์เส้นทาง

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

string

ตัวระบุของหลักสูตร ตัวระบุนี้อาจเป็นตัวระบุที่ Classroom กำหนดหรือ alias ก็ได้

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

พารามิเตอร์
courseWorkStates[]

enum (CourseWorkState)

ข้อจำกัดเกี่ยวกับสถานะงานที่ส่งคืนได้ ระบบจะแสดงเฉพาะงานในชั้นเรียนที่ตรงกัน หากไม่ระบุ ระบบจะแสดงผลรายการที่มีสถานะการทํางานเป็น PUBLISHED
orderBy

string

ลำดับการจัดเรียงผลลัพธ์ที่ไม่บังคับ รายการช่องที่คั่นด้วยคอมมาพร้อมคีย์เวิร์ดทิศทางการจัดเรียง (ไม่บังคับ) ช่องที่รองรับคือ updateTime และ dueDate คีย์เวิร์ดทิศทางที่รองรับคือ asc และ desc หากไม่ได้ระบุไว้ ระบบจะใช้ updateTime desc เป็นลักษณะการทำงานเริ่มต้น ตัวอย่าง: dueDate asc,updateTime desc, updateTime,dueDate desc
pageSize

integer

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

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

string

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

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

enum (PreviewVersion)

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

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

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

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

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

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

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

object (CourseWork)

รายการงานในชั้นเรียนที่ตรงกับคำขอ
nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/classroom.coursework.students.readonly
  • https://www.googleapis.com/auth/classroom.coursework.me.readonly
  • https://www.googleapis.com/auth/classroom.coursework.students
  • https://www.googleapis.com/auth/classroom.coursework.me

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