- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- พารามิเตอร์การค้นหา
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- ลองใช้งาน
แสดงผลรายการประกาศที่ผู้ขอดูได้
นักเรียนของหลักสูตรจะดูประกาศได้ PUBLISHED
รายการเท่านั้น ครูของหลักสูตรและผู้ดูแลระบบโดเมนอาจดูประกาศทั้งหมด
เมธอดนี้จะแสดงรหัสข้อผิดพลาดต่อไปนี้
PERMISSION_DENIED
หากผู้ใช้ที่ส่งคำขอไม่ได้รับอนุญาตให้เข้าถึงหลักสูตรที่ขอหรือเกิดข้อผิดพลาดในการเข้าถึงINVALID_ARGUMENT
หากคำขอมีรูปแบบไม่ถูกต้องNOT_FOUND
หากไม่มีหลักสูตรที่ขอ
คำขอ HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/announcements
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
courseId |
ตัวระบุของหลักสูตร ตัวระบุนี้อาจเป็นตัวระบุที่ Classroom กำหนดให้หรือ |
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
announcementStates[] |
พบการจำกัด |
orderBy |
เรียงลำดับการจัดเรียงสำหรับผลลัพธ์ (ไม่บังคับ) รายการช่องที่คั่นด้วยคอมมาซึ่งมีคีย์เวิร์ดทิศทางการจัดเรียง (ไม่บังคับ) ช่องที่รองรับคือ |
pageSize |
จำนวนรายการสูงสุดที่จะส่งคืน ค่าศูนย์หรือไม่ได้ระบุหมายความว่าเซิร์ฟเวอร์สามารถกำหนดค่าสูงสุดได้ เซิร์ฟเวอร์อาจส่งคืนผลลัพธ์น้อยกว่าจำนวนที่ระบุ |
pageToken |
ค่า คำขอ |
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
ตอบกลับเมื่อแสดงรายการหลักสูตร
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"announcements": [
{
object ( |
ช่อง | |
---|---|
announcements[] |
รายการประกาศที่ตรงกับคำขอ |
nextPageToken |
โทเค็นที่ระบุหน้าผลลัพธ์ถัดไปที่จะแสดง หากว่างเปล่า จะไม่มีผลลัพธ์เพิ่มเติม |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้
https://www.googleapis.com/auth/classroom.announcements
https://www.googleapis.com/auth/classroom.announcements.readonly
สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์