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)

حداکثر تعداد رکوردهای تاریخچه برای برگرداندن. این فیلد به صورت پیش‌فرض ۱۰۰ است. حداکثر مقدار مجاز برای این فیلد ۵۰۰ است.

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

نوع تاریخچه

انوم‌ها
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 )

برچسب اضافه شد

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

object ( Message )

labelIds[]

string

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

برچسب حذف شد

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

object ( Message )

labelIds[]

string

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