Method: users.history.list

แสดงประวัติการเปลี่ยนแปลงทั้งหมดในกล่องจดหมายที่ระบุ ระบบจะแสดงผลลัพธ์ประวัติตามลำดับเวลา (historyId ที่เพิ่มขึ้น)

คำขอ HTTP

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

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

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

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

string

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

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

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

integer (uint32 format)

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

string

โทเค็นหน้าเว็บเพื่อดึงข้อมูลหน้าผลการค้นหาที่ต้องการในรายการ
startHistoryId

string

ต้องระบุ แสดงผลระเบียนประวัติหลังจาก startHistoryId ที่ระบุ startHistoryId ที่ระบุควรมาจาก historyId ของข้อความ ชุดข้อความ หรือการตอบกลับ list ก่อนหน้า รหัสประวัติจะเพิ่มขึ้นตามลำดับเวลา แต่จะไม่ต่อเนื่องกันโดยมีช่องว่างแบบสุ่มระหว่างรหัสที่ถูกต้อง โดยทั่วไปแล้ว การให้startHistoryIdที่ไม่ถูกต้องหรือไม่เป็นปัจจุบันจะแสดงรหัสข้อผิดพลาด HTTP 404 โดยปกติแล้ว historyId จะมีผลอย่างน้อย 1 สัปดาห์ แต่บางกรณีที่เกิดขึ้นไม่บ่อยนัก historyId อาจมีผลเพียง 2-3 ชั่วโมง หากได้รับการตอบกลับข้อผิดพลาด HTTP 404 แอปพลิเคชันของคุณควรทำการซิงค์อย่างเต็มรูปแบบ หากไม่พบ nextPageToken ในการตอบกลับ แสดงว่าไม่มีข้อมูลอัปเดตที่จะดึงข้อมูล และคุณสามารถจัดเก็บ historyId ที่แสดงผลไว้สำหรับคำขอในอนาคต
labelId

string

แสดงเฉพาะข้อความที่มีป้ายกำกับตรงกับรหัส
historyTypes[]

enum (HistoryType)

ประเภทประวัติที่ฟังก์ชันจะแสดงผล

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

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

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

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

การแสดง JSON 
{
  "history": [
    {
      object (History)
    }
  ],
  "nextPageToken": string,
  "historyId": string
}
ช่อง
history[]

object (History)

รายการบันทึกประวัติ โดยปกติแล้ว messages ที่มีอยู่ในคำตอบจะมีเพียงช่อง id และ threadId เท่านั้น
nextPageToken

string

โทเค็นหน้าเว็บเพื่อดึงข้อมูลหน้าถัดไปของผลการค้นหาในรายการ
historyId

string

รหัสของระเบียนประวัติปัจจุบันของกล่องจดหมาย

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

ต้องใช้ขอบเขต 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

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

HistoryType

Enum
messageAdded
messageDeleted
labelAdded
labelRemoved

ประวัติ

บันทึกการเปลี่ยนแปลงในกล่องจดหมายของผู้ใช้ การเปลี่ยนแปลงประวัติแต่ละรายการอาจส่งผลต่อข้อความหลายรายการในหลายวิธี

การแสดง JSON 
{
  "id": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "messagesAdded": [
    {
      object (MessageAdded)
    }
  ],
  "messagesDeleted": [
    {
      object (MessageDeleted)
    }
  ],
  "labelsAdded": [
    {
      object (LabelAdded)
    }
  ],
  "labelsRemoved": [
    {
      object (LabelRemoved)
    }
  ]
}
ช่อง
id

string

รหัสลำดับกล่องจดหมาย
messages[]

object (Message)

รายการข้อความที่มีการเปลี่ยนแปลงในบันทึกประวัตินี้ ฟิลด์สำหรับการเปลี่ยนแปลงบางประเภท เช่น messagesAdded อาจทำซ้ำข้อความในช่องนี้ เราขอแนะนำให้ใช้ฟิลด์ประเภทการเปลี่ยนแปลงที่เฉพาะเจาะจงแทน
messagesAdded[]

object (MessageAdded)

ข้อความที่เพิ่มลงในกล่องจดหมายในระเบียนประวัตินี้
messagesDeleted[]

object (MessageDeleted)

ข้อความที่ถูกลบ (ไม่ใช่ย้ายไปอยู่ในถังขยะ) จากกล่องจดหมายในระเบียนประวัตินี้
labelsAdded[]

object (LabelAdded)

ป้ายกำกับที่เพิ่มลงในข้อความในระเบียนประวัตินี้
labelsRemoved[]

object (LabelRemoved)

ป้ายกำกับที่นําออกจากข้อความในบันทึกประวัตินี้

MessageAdded

การแสดง JSON 
{
  "message": {
    object (Message)
  }
}
ช่อง
message

object (Message)

MessageDeleted

การแสดง JSON 
{
  "message": {
    object (Message)
  }
}
ช่อง
message

object (Message)

LabelAdded

การแสดง JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
ช่อง
message

object (Message)
labelIds[]

string

รหัสป้ายกำกับที่เพิ่มลงในข้อความ

LabelRemoved

การแสดง JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
ช่อง
message

object (Message)
labelIds[]

string

นำรหัสป้ายกำกับออกจากข้อความ