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)

قائمة بسجلّات السجلّ عادةً ما تتم تعبئة حقلَي id وthreadId أي messages تم تضمينهما في الرد.
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

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