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

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