Method: users.drafts.list

בתיבת הדואר הנכנס של המשתמש מופיעה רשימה של הטיוטות.

בקשת HTTP

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

בכתובת ה-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".
includeSpamTrash

boolean

התוצאות יכללו טיוטות של SPAM ושל TRASH.

גוף הבקשה

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

גוף התגובה

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

ייצוג JSON 
{
  "drafts": [
    {
      object (Draft)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
שדות
drafts[]

object (Draft)

רשימת טיוטות. חשוב לשים לב שהמאפיין Message בכל משאב Draft מכיל רק id ו-threadId. השיטה messages.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.compose
  • https://www.googleapis.com/auth/gmail.readonly

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