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