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

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