Method: users.labels.list

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

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

פרמטרים
userId

string

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

גוף הבקשה

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

גוף התגובה

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

ייצוג JSON 
{
  "labels": [
    {
      object (Label)
    }
  ]
}
שדות
labels[]

object (Label)

רשימת תוויות. חשוב לשים לב שכל משאב של תווית מכיל רק id, name, messageListVisibility, labelListVisibility ו-type. השיטה labels.get יכולה לאחזר פרטים נוספים של תווית.

היקפי הרשאות

כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של 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.labels
  • https://www.googleapis.com/auth/gmail.metadata

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