Method: users.history.list

רשימה של היסטוריית כל השינויים בתיבת הדואר הנתונה. התוצאות של ההיסטוריה מוחזרות בסדר כרונולוגי (עולה historyId). מידע נוסף זמין במאמר בנושא סנכרון לקוחות עם Gmail.

בקשת HTTP

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/history

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
userId

string

כתובת האימייל של המשתמש. אפשר להשתמש בערך המיוחד me כדי לציין את המשתמש המאומת.

פרמטרים של שאילתה

פרמטרים
maxResults

integer (uint32 format)

מספר הרשומות המקסימלי של היסטוריית השיחות שיוחזרו. ערך ברירת המחדל של השדה הזה הוא 100. הערך המקסימלי המותר בשדה הזה הוא 500.
pageToken

string

אסימון דף לאחזור דף ספציפי של תוצאות ברשימה.
startHistoryId

string

חובה. מחזירה רשומות היסטוריה אחרי startHistoryId שצוין. הערך startHistoryId שצוין צריך להתקבל מהערך historyId של הודעה, שרשור או תגובה קודמת של list. מזהי ההיסטוריה עולים בסדר כרונולוגי, אבל הם לא רציפים ויש פערים אקראיים בין מזהים תקינים. אם מספקים startHistoryId לא תקף או לא עדכני, בדרך כלל מוחזר קוד שגיאה HTTP 404. historyId בדרך כלל תקף למשך שבוע לפחות, אבל בנסיבות נדירות מסוימות הוא עשוי להיות תקף רק למשך כמה שעות. אם מקבלים תגובת שגיאה HTTP 404, האפליקציה צריכה לבצע סנכרון מלא. אם לא מתקבל nextPageToken בתשובה, אין עדכונים לאחזור ואפשר לשמור את historyId שמוחזר לבקשה עתידית.
labelId

string

החזרת הודעות רק עם תווית שתואמת למזהה.
historyTypes[]

enum (HistoryType)

סוגי ההיסטוריה שיוחזרו על ידי הפונקציה

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "history": [
    {
      object (History)
    }
  ],
  "nextPageToken": string,
  "historyId": string
}
שדות
history[]

object (History)

רשימה של רשומות היסטוריות. בדרך כלל, כל messages שכלול בתגובה יכיל רק את השדות id ו-threadId.
nextPageToken

string

טוקן של דף לאחזור של דף התוצאות הבא ברשימה.
historyId

string

המזהה של רשומת ההיסטוריה הנוכחית של תיבת הדואר.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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 (Message)
    }
  ],
  "messagesAdded": [
    {
      object (MessageAdded)
    }
  ],
  "messagesDeleted": [
    {
      object (MessageDeleted)
    }
  ],
  "labelsAdded": [
    {
      object (LabelAdded)
    }
  ],
  "labelsRemoved": [
    {
      object (LabelRemoved)
    }
  ]
}
שדות
id

string

המזהה של רצף תיבת הדואר.
messages[]

object (Message)

רשימת ההודעות ששונו ברשומה הזו של ההיסטוריה. השדות של סוגי שינויים ספציפיים, כמו messagesAdded, עשויים לשכפל הודעות בשדה הזה. מומלץ להשתמש בשדות הספציפיים של סוג השינוי במקום בשדה הזה.
messagesAdded[]

object (MessageAdded)

הודעות שנוספו לתיבת הדואר ברשומה הזו של ההיסטוריה.
messagesDeleted[]

object (MessageDeleted)

הודעות שנמחקו (לא הועברו לאשפה) מתיבת הדואר ברשומת ההיסטוריה הזו.
labelsAdded[]

object (LabelAdded)

תוויות שנוספו להודעות ברשומה הזו של ההיסטוריה.
labelsRemoved[]

object (LabelRemoved)

תוויות שהוסרו מההודעות ברשומה הזו של ההיסטוריה.

MessageAdded

ייצוג JSON 
{
  "message": {
    object (Message)
  }
}
שדות
message

object (Message)

MessageDeleted

ייצוג JSON 
{
  "message": {
    object (Message)
  }
}
שדות
message

object (Message)

LabelAdded

ייצוג JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
שדות
message

object (Message)
labelIds[]

string

מזהי התוויות נוספים להודעה.

LabelRemoved

ייצוג JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
שדות
message

object (Message)
labelIds[]

string

מזהי התוויות הוסרו מההודעה.