Method: users.getProfile
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
نمایه جیمیل کاربر فعلی را دریافت می کند.
درخواست HTTP
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/profile
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها |
---|
userId | string آدرس ایمیل کاربر. مقدار ویژه me می تواند برای نشان دادن کاربر تأیید شده استفاده شود. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
نمایه یک کاربر جیمیل.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی 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
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# Method: users.getProfile\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.Profile.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nGets the current user's Gmail profile.\n\n### HTTP request\n\n`GET https://gmail.googleapis.com/gmail/v1/users/{userId}/profile`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------|\n| `userId` | `string` The user's email address. The special value `me` can be used to indicate the authenticated user. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nProfile for a Gmail user.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------|\n| ``` { \"emailAddress\": string, \"messagesTotal\": integer, \"threadsTotal\": integer, \"historyId\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------|\n| `emailAddress` | `string` The user's email address. |\n| `messagesTotal` | `integer` The total number of messages in the mailbox. |\n| `threadsTotal` | `integer` The total number of threads in the mailbox. |\n| `historyId` | `string` The ID of the mailbox's current history record. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://mail.google.com/`\n- `\n https://www.googleapis.com/auth/gmail.modify`\n- `\n https://www.googleapis.com/auth/gmail.compose`\n- `\n https://www.googleapis.com/auth/gmail.readonly`\n- `\n https://www.googleapis.com/auth/gmail.metadata`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]