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

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