- HTTP 要求
- 路徑參數
- 查詢參數
- 要求主體
- 回應主體
- 授權範圍
- HistoryType
- 歷史記錄
- MessageAdded
- MessageDeleted
- LabelAdded:
- LabelRemoved
- 試試看!
列出指定信箱的所有變更記錄。歷史記錄結果會依時間順序傳回 (遞增單位為 historyId
)。
HTTP 要求
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/history
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
userId |
使用者的電子郵件地址。特殊值 |
查詢參數
參數 | |
---|---|
maxResults |
要傳回的歷史記錄記錄數量上限。這個欄位預設為 100。這個欄位允許的最大值為 500。 |
pageToken |
用來擷取清單中特定結果頁面的網頁符記。 |
startHistoryId |
必要欄位。傳回指定 |
labelId |
只傳回含有該 ID 相符標籤的郵件。 |
historyTypes[] |
函式要傳回的記錄類型 |
要求主體
要求主體必須為空白。
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"history": [
{
object ( |
欄位 | |
---|---|
history[] |
歷史記錄清單。回應中的任何 |
nextPageToken |
用於擷取清單中結果下一頁結果的網頁符記。 |
historyId |
信箱目前記錄的 ID。 |
授權範圍
需要下列其中一種 OAuth 範圍:
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
詳情請參閱授權指南。
HistoryType
列舉 | |
---|---|
messageAdded |
|
messageDeleted |
|
labelAdded |
|
labelRemoved |
記錄
使用者信箱的變更記錄。每項記錄變更可能會對多則訊息造成多項影響。
JSON 表示法 |
---|
{ "id": string, "messages": [ { object ( |
欄位 | |
---|---|
id |
信箱序列 ID。 |
messages[] |
這份記錄中有已變更訊息的清單。特定變更類型 (例如 |
messagesAdded[] |
訊息已新增至這份記錄中的信箱。 |
messagesDeleted[] |
這份記錄含有已從信箱刪除 (未移至垃圾桶) 的郵件。 |
labelsAdded[] |
已為這筆記錄中的訊息新增標籤。 |
labelsRemoved[] |
標籤已從這份歷史記錄中的訊息中移除。 |
MessageAdded
JSON 表示法 |
---|
{
"message": {
object ( |
欄位 | |
---|---|
message |
|
MessageDeleted
JSON 表示法 |
---|
{
"message": {
object ( |
欄位 | |
---|---|
message |
|
LabelAdded
JSON 表示法 |
---|
{
"message": {
object ( |
欄位 | |
---|---|
message |
|
labelIds[] |
已將標籤 ID 加入郵件。 |
LabelRemoved
JSON 表示法 |
---|
{
"message": {
object ( |
欄位 | |
---|---|
message |
|
labelIds[] |
已將標籤 ID 從郵件中移除。 |