- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- พารามิเตอร์การค้นหา
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- ลองใช้งาน
แสดงรายการชุดข้อความในกล่องจดหมายของผู้ใช้
คำขอ HTTP
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/threads
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
userId |
อีเมลของผู้ใช้ สามารถใช้ค่าพิเศษ |
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
maxResults |
จำนวนชุดข้อความสูงสุดที่จะแสดง ช่องนี้จะมีค่าเริ่มต้นเป็น 100 ค่าสูงสุดที่อนุญาตสำหรับช่องนี้คือ 500 |
pageToken |
โทเค็นหน้าเพื่อดึงหน้าผลลัพธ์ที่ต้องการในรายการ |
q |
แสดงผลเฉพาะชุดข้อความที่ตรงกับคำค้นหาที่ระบุ รองรับรูปแบบการค้นหาเดียวกันกับช่องค้นหาของ Gmail เช่น |
labelIds[] |
แสดงผลเฉพาะชุดข้อความที่มีป้ายกำกับที่ตรงกับรหัสป้ายกำกับที่ระบุทั้งหมดเท่านั้น |
includeSpamTrash |
รวมชุดข้อความจาก |
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"threads": [
{
object ( |
ช่อง | |
---|---|
threads[] |
รายการชุดข้อความ โปรดทราบว่าทรัพยากรของชุดข้อความแต่ละรายการจะไม่มีรายการ |
nextPageToken |
โทเค็นหน้าสำหรับเรียกหน้าถัดไปของผลการค้นหาในรายการ |
resultSizeEstimate |
จำนวนผลลัพธ์ทั้งหมดโดยประมาณ |
ขอบเขตการให้สิทธิ์
ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
https://www.googleapis.com/auth/gmail.readonly
https://www.googleapis.com/auth/gmail.metadata
โปรดดูข้อมูลเพิ่มเติมที่คู่มือการให้สิทธิ์