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 สัปดาห์ แต่ในบางกรณีซึ่งเกิดขึ้นไม่บ่อยนักอาจใช้ได้เพียงไม่กี่ชั่วโมง หากคุณได้รับการตอบกลับแสดงข้อผิดพลาด 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

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