Method: courses.announcements.list

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

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

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

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

คำขอ HTTP

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

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

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

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

string

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

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

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

enum (AnnouncementState)

การจำกัด state ของประกาศที่แสดงผล หากไม่ได้ระบุค่าของอาร์กิวเมนต์นี้ ค่าเริ่มต้นคือ PUBLISHED
orderBy

string

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

integer

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

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

string

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

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

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

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

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

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

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

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

object (Announcement)

รายการประกาศที่ตรงกับคำขอ
nextPageToken

string

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

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

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

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