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

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