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

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