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

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