Method: users.history.list

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

בקשת HTTP

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

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

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

פרמטרים
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

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