Method: users.threads.list

แสดงรายการชุดข้อความในกล่องจดหมายของผู้ใช้

คำขอ HTTP

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/threads

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

พารามิเตอร์เส้นทาง

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

string

อีเมลของผู้ใช้ สามารถใช้ค่าพิเศษ me เพื่อระบุผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

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

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

integer (uint32 format)

จำนวนชุดข้อความสูงสุดที่จะแสดง ช่องนี้จะมีค่าเริ่มต้นเป็น 100 ค่าสูงสุดที่อนุญาตสำหรับช่องนี้คือ 500
pageToken

string

โทเค็นหน้าเพื่อดึงหน้าผลลัพธ์ที่ต้องการในรายการ
q

string

แสดงผลเฉพาะชุดข้อความที่ตรงกับคำค้นหาที่ระบุ รองรับรูปแบบการค้นหาเดียวกันกับช่องค้นหาของ Gmail เช่น "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread" ไม่สามารถใช้พารามิเตอร์เมื่อเข้าถึง API โดยใช้ขอบเขต gmail.metadata
labelIds[]

string

แสดงผลเฉพาะชุดข้อความที่มีป้ายกำกับที่ตรงกับรหัสป้ายกำกับที่ระบุทั้งหมดเท่านั้น
includeSpamTrash

boolean

รวมชุดข้อความจาก SPAM และ TRASH ในผลลัพธ์

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

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

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

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

การแสดง JSON 
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
ช่อง
threads[]

object (Thread)

รายการชุดข้อความ โปรดทราบว่าทรัพยากรของชุดข้อความแต่ละรายการจะไม่มีรายการ messages ดึงข้อมูลรายการ messages สำหรับชุดข้อความได้โดยใช้เมธอด threads.get
nextPageToken

string

โทเค็นหน้าสำหรับเรียกหน้าถัดไปของผลการค้นหาในรายการ
resultSizeEstimate

integer (uint32 format)

จำนวนผลลัพธ์ทั้งหมดโดยประมาณ

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

ต้องมีขอบเขต 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

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