- בקשת HTTP
- פרמטרים של נתיב
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- HistoryType
- היסטוריה
- MessageAdded
- MessageDeleted
- LabelAdded
- LabelRemoved
- רוצים לנסות?
מפרטת את ההיסטוריה של כל השינויים בתיבת הדואר הנתונה. תוצאות ההיסטוריה מוחזרות בסדר כרונולוגי (historyId
בעלייה).
בקשת HTTP
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/history
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
userId |
כתובת האימייל של המשתמש. אפשר להשתמש בערך המיוחד |
פרמטרים של שאילתה
פרמטרים | |
---|---|
maxResults |
המספר המקסימלי של רשומות היסטוריה שצריך להחזיר. ערך ברירת המחדל של השדה הזה הוא 100. הערך המקסימלי המותר לשדה הזה הוא 500. |
pageToken |
אסימון של דף לאחזור דף ספציפי של תוצאות ברשימה. |
startHistoryId |
חובה. הפונקציה מחזירה את נתוני ההיסטוריה אחרי הערך שצוין בשדה |
labelId |
מוחזר רק הודעות עם תווית שתואמת למזהה. |
historyTypes[] |
סוגי ההיסטוריה שיוחזרו על ידי הפונקציה |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"history": [
{
object ( |
שדות | |
---|---|
history[] |
רשימת רשומות ההיסטוריה. בכל שדה |
nextPageToken |
אסימון דף לאחזור דף התוצאות הבא ברשימה. |
historyId |
המזהה של רשומת ההיסטוריה הנוכחית של תיבת הדואר. |
היקפי ההרשאות
נדרש אחד מהיקפי ההרשאות הבאים של 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
טיפוסים בני מנייה (enum) | |
---|---|
messageAdded |
|
messageDeleted |
|
labelAdded |
|
labelRemoved |
היסטוריה
רשומה שכוללת שינוי בתיבת הדואר של המשתמש. כל שינוי בהיסטוריה עשוי להשפיע על כמה הודעות בכמה דרכים.
ייצוג JSON |
---|
{ "id": string, "messages": [ { object ( |
שדות | |
---|---|
id |
מזהה הרצף של תיבת הדואר. |
messages[] |
רשימת ההודעות שהשתנו ברשומת ההיסטוריה הזו. יכול להיות שבשדות של סוגי השינוי הספציפיים, כמו |
messagesAdded[] |
הודעות שנוספו לתיבת הדואר ברשומת ההיסטוריה הזו. |
messagesDeleted[] |
הודעות שנמחקו (לא הועברו לאשפה) מתיבת הדואר ברשומת ההיסטוריה הזו. |
labelsAdded[] |
תוויות שנוספו להודעות ברשומת ההיסטוריה הזו. |
labelsRemoved[] |
תוויות שהוסרו מההודעות ברשומת ההיסטוריה הזו. |
MessageAdded
ייצוג JSON |
---|
{
"message": {
object ( |
שדות | |
---|---|
message |
|
MessageDeleted
ייצוג JSON |
---|
{
"message": {
object ( |
שדות | |
---|---|
message |
|
LabelAdded
ייצוג JSON |
---|
{
"message": {
object ( |
שדות | |
---|---|
message |
|
labelIds[] |
מזהי התוויות נוספו להודעה. |
LabelRemoved
ייצוג JSON |
---|
{
"message": {
object ( |
שדות | |
---|---|
message |
|
labelIds[] |
מזהי התוויות הוסרו מההודעה. |