- 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ê 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 |
Địa chỉ email của người dùng. Bạn có thể sử dụng giá trị đặc biệt |
Tham số truy vấn
Các tham số | |
---|---|
maxResults |
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 |
Mã thông báo trang để truy xuấ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ả về những thư có nhãn khớp với mã nhận dạng. |
historyTypes[] |
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 ( |
Các 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 tiếp theo của kết quả trong danh sách. |
historyId |
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 ( |
Các trường | |
---|---|
id |
Mã trình tự của 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êm tin nhắn vào hộp thư trong bản ghi nhật ký này. |
messagesDeleted[] |
Đã 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[] |
Nhãn được thêm vào thư trong bản ghi lịch sử 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 ( |
Các trường | |
---|---|
message |
|
MessageDeleted
Biểu diễn dưới dạng JSON |
---|
{
"message": {
object ( |
Các trường | |
---|---|
message |
|
LabelAdded
Biểu diễn dưới dạng JSON |
---|
{
"message": {
object ( |
Các trường | |
---|---|
message |
|
labelIds[] |
Đã thêm mã nhận dạng nhãn vào thư. |
LabelRemoved
Biểu diễn dưới dạng JSON |
---|
{
"message": {
object ( |
Các trường | |
---|---|
message |
|
labelIds[] |
Đã xoá mã nhận dạng nhãn khỏi thư. |