Method: users.threads.list

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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

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