يسرد سلاسل المحادثات في صندوق بريد المستخدم.
طلب HTTP
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/threads
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المَعلمات | |
---|---|
userId |
عنوان البريد الإلكتروني للمستخدم يمكن استخدام القيمة الخاصة |
معلمات طلب البحث
المَعلمات | |
---|---|
maxResults |
الحد الأقصى لعدد سلاسل المحادثات المطلوب عرضها. القيمة التلقائية لهذا الحقل هي 100. الحد الأقصى المسموح به للقيمة في هذا الحقل هو 500. |
pageToken |
الرمز المميز للصفحة لاسترداد صفحة محدّدة من النتائج في القائمة |
q |
عرض سلاسل المحادثات التي تطابق الاستعلام المحدد فقط. يتيح استخدام تنسيق طلب البحث نفسه الذي يظهر في مربّع بحث Gmail. مثلاً: |
labelIds[] |
لا تعرض سوى سلاسل المحادثات التي تحتوي على تصنيفات تتطابق مع جميع أرقام تعريف التصنيفات المحدّدة. |
includeSpamTrash |
تضمين سلاسل محادثات من |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"threads": [
{
object ( |
الحقول | |
---|---|
threads[] |
قائمة سلاسل المحادثات. لاحظ أن كل مورد في سلسلة المحادثات لا يحتوي على قائمة من |
nextPageToken |
الرمز المميز للصفحة لاسترداد الصفحة التالية من النتائج في القائمة |
resultSizeEstimate |
إجمالي العدد المقدّر للنتائج. |
نطاقات التفويض
يتطلب استخدام أحد نطاقات 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
لمزيد من المعلومات، راجِع دليل التفويض.