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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.