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

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.