Method: users.history.list

Liệt kê nhật ký của tất cả thay đổi đối với hộp thư đã cho. Kết quả nhật ký được trả về theo thứ tự thời gian (tăng 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

Tham số
userId

string

Địa chỉ email của người dùng. Giá trị đặc biệt me có thể dùng để cho biết người dùng đã được xác thực.

Tham số truy vấn

Tham số
maxResults

integer (uint32 format)

Số lượng bản ghi lịch sử tối đa cần trả về. Trường này được mặc định 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 mộ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 đã 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ật ký tăng theo trình tự thời gian nhưng không liền kề với khoảng trống ngẫu nhiên giữa các mã nhận dạng 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, thì ứng dụng của bạn sẽ tiến hành đồng bộ hoá toàn bộ. Nếu bạn không nhận được nextPageToken trong phản hồi thì tức là không có thông tin cập nhật nào để truy xuất và bạn có thể lưu trữ historyId được trả về cho yêu cầu sau này.
labelId

string

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

enum (HistoryType)

Loại lịch sử được 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
}
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 sẽ chỉ điền sẵn các trường id và threadId.
nextPageToken

string

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

string

Mã của bản ghi nhật ký 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 đối với 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)
    }
  ]
}
Trường
id

string

Mã trình tự 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ể sẽ có thông báo trùng lặp trong trường này. Bạn nên sử dụng các trường loại thay đổi cụ thể thay vì trường này.
messagesAdded[]

object (MessageAdded)

Thư đã được thêm vào hộp thư trong bản ghi nhật ký này.
messagesDeleted[]

object (MessageDeleted)

Thư đã bị xoá (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 nhật ký 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)
  }
}
Trường
message

object (Message)

MessageDeleted

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

object (Message)

LabelAdded

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

object (Message)
labelIds[]

string

Đã thêm mã nhãn vào thư.

LabelRemoved

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

object (Message)
labelIds[]

string

Đã xoá mã nhãn khỏi thư.