Method: users.getProfile

קבלת הפרופיל של המשתמש הנוכחי ב-Gmail.

בקשת HTTP

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

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

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

פרמטרים
userId

string

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

גוף הבקשה

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

גוף התגובה

פרופיל של משתמש Gmail.

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

ייצוג JSON 
{
  "emailAddress": string,
  "messagesTotal": integer,
  "threadsTotal": integer,
  "historyId": string
}
שדות
emailAddress

string

זוהי כתובת האימייל של המשתמש.
messagesTotal

integer

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

integer

המספר הכולל של השרשורים בתיבת הדואר.
historyId

string

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

היקפי הרשאות

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

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