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

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