Method: users.labels.list

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

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

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

פרמטרים
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

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.