Method: users.history.list

يسرد سجلّ جميع التغييرات التي تم إجراؤها على صندوق البريد المحدد. يتم عرض نتائج السجلّ بترتيب زمني (historyId تصاعدي).

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز 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

عمليات التعداد
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

تمّت إزالة معرّفات التصنيفات من الرسالة.