Method: users.getProfile
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recupera o perfil do Gmail do usuário atual.
Solicitação HTTP
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/profile
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
userId |
string
O endereço de e-mail do usuário. O valor especial me pode ser usado para indicar o usuário autenticado.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Perfil de um usuário do Gmail.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Representação JSON |
{
"emailAddress": string,
"messagesTotal": integer,
"threadsTotal": integer,
"historyId": string
} |
| Campos |
emailAddress |
string
O endereço de e-mail do usuário.
|
messagesTotal |
integer
O número total de mensagens na caixa de correio.
|
threadsTotal |
integer
O número total de linhas na caixa de correio.
|
historyId |
string
O ID do registro de histórico atual da caixa de correio.
|
Escopos de autorização
Requer um dos seguintes escopos do 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
Para mais informações, consulte o guia de autorização.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[],[],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)."]]
