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

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