Method: invitations.list

แสดงผลรายการคำเชิญที่ผู้ใช้ที่ส่งคำขอได้รับอนุญาตให้ดู โดยจำกัดไว้เฉพาะรายการที่ตรงกับคำขอรายการ

หมายเหตุ: ต้องระบุ userId หรือ courseId อย่างน้อย 1 รายการ ต้องระบุทั้ง 2 ช่อง

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

คำขอ HTTP

GET https://classroom.googleapis.com/v1/invitations

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

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

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

string

จำกัดการส่งคืนคำเชิญให้กับคำเชิญของผู้ใช้ที่ระบุ ตัวระบุอาจเป็นอย่างใดอย่างหนึ่งต่อไปนี้

  • ตัวระบุที่เป็นตัวเลขสำหรับผู้ใช้
  • อีเมลของผู้ใช้
  • สตริง "me" ซึ่งระบุผู้ใช้ที่ส่งคำขอ
courseId

string

จำกัดการตอบกลับคำเชิญที่ส่งให้กับผู้สำหรับหลักสูตรที่มีตัวระบุที่ระบุ

pageSize

integer

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

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

pageToken

string

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

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

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

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

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

ตอบกลับเมื่อแสดงคําเชิญ

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

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

object (Invitation)

คำเชิญที่ตรงกับคำขอรายการ

nextPageToken

string

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

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

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

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

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