Method: users.history.list

Liệt kê lịch sử của tất cả các thay đổi đối với hộp thư cụ thể. Kết quả trong nhật ký được trả về theo thứ tự thời gian (tăng dần historyId).

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Các tham số
userId

string

Địa chỉ email của người dùng. Bạn có thể sử dụng giá trị đặc biệt me để cho biết người dùng đã xác thực.

Tham số truy vấn

Các tham số
maxResults

integer (uint32 format)

Số lượng bản ghi nhật ký tối đa cần trả về. Theo mặc định, trường này là 100. Giá trị tối đa được phép cho trường này là 500.
pageToken

string

Mã thông báo trang để truy xuất trang kết quả cụ thể trong danh sách.
startHistoryId

string

Bắt buộc. Trả về các bản ghi nhật ký sau startHistoryId được chỉ định. startHistoryId được cung cấp phải được lấy từ historyId của một tin nhắn, chuỗi hoặc phản hồi list trước đó. Mã nhận dạng nhật ký tăng theo trình tự thời gian nhưng không liền kề với khoảng cách ngẫu nhiên giữa các mã hợp lệ. Việc cung cấp startHistoryId không hợp lệ hoặc đã lỗi thời thường trả về mã lỗi HTTP 404. historyId thường có hiệu lực trong ít nhất một tuần, nhưng trong một số ít trường hợp, có thể chỉ có hiệu lực trong vài giờ. Nếu bạn nhận được phản hồi lỗi HTTP 404, ứng dụng của bạn sẽ thực hiện đồng bộ hoá toàn bộ. Nếu không nhận được nextPageToken nào trong phản hồi, thì tức là không có nội dung cập nhật nào để truy xuất và bạn có thể lưu trữ historyId được trả về cho một yêu cầu trong tương lai.
labelId

string

Chỉ trả về những thư có nhãn khớp với mã nhận dạng.
historyTypes[]

enum (HistoryType)

Các loại nhật ký mà hàm trả về

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "history": [
    {
      object (History)
    }
  ],
  "nextPageToken": string,
  "historyId": string
}
Các trường
history[]

object (History)

Danh sách bản ghi nhật ký. Mọi messages có trong phản hồi thường chỉ được điền sẵn các trường id và threadId.
nextPageToken

string

Mã thông báo trang để truy xuất trang tiếp theo của kết quả trong danh sách.
historyId

string

Mã của bản ghi lịch sử hiện tại của hộp thư.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • 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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.

HistoryType

Enum
messageAdded
messageDeleted
labelAdded
labelRemoved

Cập nhật trước đây

Bản ghi về thay đổi đối với hộp thư của người dùng. Mỗi thay đổi trong nhật ký có thể ảnh hưởng đến nhiều thư theo nhiều cách.

Biểu diễn dưới dạng JSON 
{
  "id": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "messagesAdded": [
    {
      object (MessageAdded)
    }
  ],
  "messagesDeleted": [
    {
      object (MessageDeleted)
    }
  ],
  "labelsAdded": [
    {
      object (LabelAdded)
    }
  ],
  "labelsRemoved": [
    {
      object (LabelRemoved)
    }
  ]
}
Các trường
id

string

Mã trình tự của hộp thư.
messages[]

object (Message)

Danh sách tin nhắn đã thay đổi trong bản ghi nhật ký này. Các trường dành cho những loại thay đổi cụ thể, chẳng hạn như messagesAdded, có thể sao chép thông báo trong trường này. Bạn nên sử dụng các trường loại thay đổi cụ thể thay cho trường này.
messagesAdded[]

object (MessageAdded)

Đã thêm tin nhắn vào hộp thư trong bản ghi nhật ký này.
messagesDeleted[]

object (MessageDeleted)

Đã xoá thư (không bị Chuyển vào thùng rác) khỏi hộp thư trong bản ghi nhật ký này.
labelsAdded[]

object (LabelAdded)

Nhãn được thêm vào thư trong bản ghi lịch sử này.
labelsRemoved[]

object (LabelRemoved)

Đã xoá nhãn khỏi thư trong bản ghi nhật ký này.

MessageAdded

Biểu diễn dưới dạng JSON 
{
  "message": {
    object (Message)
  }
}
Các trường
message

object (Message)

MessageDeleted

Biểu diễn dưới dạng JSON 
{
  "message": {
    object (Message)
  }
}
Các trường
message

object (Message)

LabelAdded

Biểu diễn dưới dạng JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Các trường
message

object (Message)
labelIds[]

string

Đã thêm mã nhận dạng nhãn vào thư.

LabelRemoved

Biểu diễn dưới dạng JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Các trường
message

object (Message)
labelIds[]

string

Đã xoá mã nhận dạng nhãn khỏi thư.