Method: users.history.list

Liệt kê nhật ký của tất cả cá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 (historyId tăng dần).

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

Thông số
userId

string

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

Tham số truy vấn

Thông số
maxResults

integer (uint32 format)

Số lượng bản ghi nhật ký tối đa cần trả về. Trường này 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 được cung cấp phải được lấy từ historyId của một thông báo, 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 tục với các 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 đã hết hạn thường trả về mã lỗi HTTP 404. historyId thường có hiệu lực ít nhất một tuần, nhưng trong một số ít trường hợp, historyId chỉ có hiệu lực trong vài giờ. Nếu nhận được phản hồi lỗi HTTP 404, ứng dụng của bạn phải thực hiện quy trình đồng bộ hoá đầy đủ. Nếu bạn không nhận được nextPageToken trong phản hồi, tức là không có thông tin cập nhật nào cần truy xuất và bạn có thể lưu trữ historyId đã 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 sẽ 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 các bản ghi nhật ký. Mọi messages có trong phản hồi thường chỉ có các trường id và threadId được điền sẵn.
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 OAuth 2.0 Overview.

HistoryType

Enum
messageAdded
messageDeleted
labelAdded
labelRemoved

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

Bản ghi về một 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ông báo 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ã nhận dạng chuỗi hộp thư.
messages[]

object (Message)

Danh sách các tin nhắn đã thay đổi trong bản ghi nhật ký này. Các trường cho các loại thay đổi cụ thể, chẳng hạn như messagesAdded có thể trùng lặ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 vì trường này.
messagesAdded[]

object (MessageAdded)

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

object (MessageDeleted)

Các thư đã bị xoá (không phải 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)

Nhãn bị xoá 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

Mã nhận dạng nhãn được thêm 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 dạng nhãn khỏi thư.