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)

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

string

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

integer

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

เซิร์ฟเวอร์อาจส่งคืนผลลัพธ์น้อยกว่าจำนวนที่ระบุ
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

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