Method: users.history.list

تاریخچه همه تغییرات در صندوق پستی داده شده را فهرست می کند. نتایج تاریخچه به ترتیب زمانی برگردانده می شوند (افزایش historyId ).

درخواست 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

Enums
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 )

برچسب‌های حذف شده از پیام‌های موجود در این سابقه سابقه.

پیام اضافه شد

نمایندگی JSON 
{
  "message": {
    object (Message)
  }
}
فیلدها
message

object ( Message )

پیام حذف شد

نمایندگی JSON 
{
  "message": {
    object (Message)
  }
}
فیلدها
message

object ( Message )

LabelAdded

نمایندگی JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
فیلدها
message

object ( Message )

labelIds[]

string

شناسه‌های برچسب به پیام اضافه شدند.

برچسب حذف شد

نمایندگی JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
فیلدها
message

object ( Message )

labelIds[]

string

شناسه‌های برچسب از پیام حذف شدند.