Method: courses.courseWorkMaterials.list

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

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

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

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

คำขอ HTTP

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

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

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

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

string

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

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

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

enum (CourseWorkMaterialState)

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

string

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

integer

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

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

string

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

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

string

การกรองที่ไม่บังคับสำหรับเนื้อหางานในหลักสูตรซึ่งมีเนื้อหาในไดรฟ์อย่างน้อย 1 รายการที่มีรหัสตรงกับสตริงที่ระบุ หากระบุ materialLink ด้วย สื่อการเรียนการสอนต้องมีเนื้อหาที่ตรงกับทั้ง 2 ตัวกรอง

เนื้อความของคำขอ

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

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

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

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

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

object (CourseWorkMaterial)

รายการเนื้อหาสำหรับงานในหลักสูตรที่ตรงกับคำขอ
nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/classroom.courseworkmaterials
  • https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly

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