Method: users.threads.list

يسرد سلاسل المحادثات في صندوق بريد المستخدم.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
userId

string

عنوان البريد الإلكتروني للمستخدم يمكن استخدام القيمة الخاصة me للإشارة إلى المستخدم الذي تمت مصادقته.

معلمات طلب البحث

المَعلمات
maxResults

integer (uint32 format)

الحد الأقصى لعدد سلاسل المحادثات المطلوب عرضها. القيمة التلقائية لهذا الحقل هي 100. الحد الأقصى المسموح به للقيمة في هذا الحقل هو 500.

pageToken

string

الرمز المميز للصفحة لاسترداد صفحة محدّدة من النتائج في القائمة

q

string

عرض سلاسل المحادثات التي تطابق الاستعلام المحدد فقط. يتيح استخدام تنسيق طلب البحث نفسه الذي يظهر في مربّع بحث Gmail. مثلاً: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread" لا يمكن استخدام المعلَمة عند الوصول إلى واجهة برمجة التطبيقات باستخدام نطاق gmail.metadata.

labelIds[]

string

لا تعرض سوى سلاسل المحادثات التي تحتوي على تصنيفات تتطابق مع جميع أرقام تعريف التصنيفات المحدّدة.

includeSpamTrash

boolean

تضمين سلاسل محادثات من SPAM وTRASH في النتائج.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
الحقول
threads[]

object (Thread)

قائمة سلاسل المحادثات. لاحظ أن كل مورد في سلسلة المحادثات لا يحتوي على قائمة من messages. يمكن استرجاع قائمة messages لسلسلة محادثات معيّنة باستخدام طريقة threads.get.

nextPageToken

string

الرمز المميز للصفحة لاسترداد الصفحة التالية من النتائج في القائمة

resultSizeEstimate

integer (uint32 format)

إجمالي العدد المقدّر للنتائج.

نطاقات التفويض

يتطلب استخدام أحد نطاقات 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

لمزيد من المعلومات، راجِع دليل التفويض.