- Yêu cầu HTTP
- Tham số đường dẫn
- Tham số truy vấn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi uỷ quyền
- HistoryType
- Nhật ký
- MessageAdded
- MessageDeleted
- LabelAdded
- LabelRemoved
- Hãy làm thử!
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 |
Địa chỉ email của người dùng. Giá trị đặc biệt |
Tham số truy vấn
Tham số | |
---|---|
maxResults |
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 |
Mã thông báo trang để truy xuất một trang kết quả cụ thể trong danh sách. |
startHistoryId |
Bắt buộc. Trả về các bản ghi nhật ký sau |
labelId |
Chỉ trả lại thư có nhãn khớp với mã nhận dạng. |
historyTypes[] |
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 ( |
Trường | |
---|---|
history[] |
Danh sách bản ghi nhật ký. Mọi |
nextPageToken |
Mã thông báo trang để truy xuất trang kết quả tiếp theo trong danh sách. |
historyId |
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 ( |
Trường | |
---|---|
id |
Mã trình tự hộp thư. |
messages[] |
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[] |
Thư đã được thêm vào hộp thư trong bản ghi nhật ký này. |
messagesDeleted[] |
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[] |
Nhãn được thêm vào thư trong bản ghi nhật ký này. |
labelsRemoved[] |
Đã 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 ( |
Trường | |
---|---|
message |
|
MessageDeleted
Biểu diễn dưới dạng JSON |
---|
{
"message": {
object ( |
Trường | |
---|---|
message |
|
LabelAdded
Biểu diễn dưới dạng JSON |
---|
{
"message": {
object ( |
Trường | |
---|---|
message |
|
labelIds[] |
Đã thêm mã nhãn vào thư. |
LabelRemoved
Biểu diễn dưới dạng JSON |
---|
{
"message": {
object ( |
Trường | |
---|---|
message |
|
labelIds[] |
Đã xoá mã nhãn khỏi thư. |