Method: users.getProfile

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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

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