Method: users.threads.list

מציג את השרשורים בתיבת הדואר של המשתמש.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
userId

string

כתובת האימייל של המשתמש. אפשר להשתמש בערך המיוחד me כדי לציין את המשתמש המאומת.

פרמטרים של שאילתה

פרמטרים
maxResults

integer (uint32 format)

מספר השרשורים המקסימלי שיוחזרו. ערך ברירת המחדל של השדה הזה הוא 100. הערך המקסימלי המותר בשדה הזה הוא 500.
pageToken

string

אסימון דף לאחזור דף ספציפי של תוצאות ברשימה.
q

string

מחזירה רק שרשורים שתואמים לשאילתה שצוינה. תומך באותו פורמט של שאילתות כמו בתיבת החיפוש של Gmail. לדוגמה, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". אי אפשר להשתמש בפרמטר כשניגשים ל-API באמצעות ההיקף gmail.metadata.
labelIds[]

string

מחזירה רק שרשורים עם תוויות שתואמות לכל מזהי התוויות שצוינו.
includeSpamTrash

boolean

הכללת שרשורים מ-SPAM ומ-TRASH בתוצאות.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
שדות
threads[]

object (Thread)

רשימת השרשורים. שימו לב שכל משאב של שרשור לא מכיל רשימה של messages. אפשר לאחזר את רשימת messages של שרשור מסוים באמצעות ה-method‏ 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.