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

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