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". לא ניתן להשתמש בפרמטר כשניגשים לממשק ה-API באמצעות ההיקף 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

למידע נוסף, ניתן לעיין במדריך ההרשאות.