Method: users.messages.list
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
HTTP-запрос
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/messages
URL-адрес использует синтаксис gRPC Transcoding .
Параметры пути
| Параметры |
|---|
userId | string Адрес электронной почты пользователя. Специальное значение me может использоваться для указания аутентифицированного пользователя. |
Параметры запроса
| Параметры |
|---|
maxResults | integer ( uint32 format) Максимальное количество возвращаемых сообщений. Значение этого поля по умолчанию — 100. Максимально допустимое значение для этого поля — 500. |
pageToken | string Токен страницы для извлечения определенной страницы результатов в списке. |
q | string Возвращать только сообщения, соответствующие указанному запросу. Поддерживает тот же формат запроса, что и поле поиска Gmail. Например, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread" . Параметр нельзя использовать при доступе к API с использованием области действия gmail.metadata. |
labelIds[] | string Возвращать только сообщения с метками, которые соответствуют всем указанным идентификаторам меток. Сообщения в потоке могут иметь метки, которых нет у других сообщений в том же потоке. Чтобы узнать больше, см. Управление метками сообщений и потоков . |
includeSpamTrash | boolean Включить в результаты сообщения из SPAM и TRASH . |
Текст запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит данные со следующей структурой:
| JSON-представление |
|---|
{
"messages": [
{
object (Message)
}
],
"nextPageToken": string,
"resultSizeEstimate": integer
} |
| Поля |
|---|
messages[] | object ( Message ) Список сообщений. Обратите внимание, что каждый ресурс сообщения содержит только id и threadId . Дополнительные сведения о сообщении можно получить с помощью метода messages.get . |
nextPageToken | string Токен для получения следующей страницы результатов в списке. |
resultSizeEstimate | integer ( uint32 format) Предполагаемое общее количество результатов. |
Области действия авторизации
Требуется одна из следующих областей 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.metadata
Более подробную информацию см. в Руководстве по авторизации .
,
HTTP-запрос
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/messages
URL-адрес использует синтаксис gRPC Transcoding .
Параметры пути
| Параметры |
|---|
userId | string Адрес электронной почты пользователя. Специальное значение me может использоваться для указания аутентифицированного пользователя. |
Параметры запроса
| Параметры |
|---|
maxResults | integer ( uint32 format) Максимальное количество возвращаемых сообщений. Значение этого поля по умолчанию — 100. Максимально допустимое значение для этого поля — 500. |
pageToken | string Токен страницы для извлечения определенной страницы результатов в списке. |
q | string Возвращать только сообщения, соответствующие указанному запросу. Поддерживает тот же формат запроса, что и поле поиска Gmail. Например, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread" . Параметр нельзя использовать при доступе к API с использованием области действия gmail.metadata. |
labelIds[] | string Возвращать только сообщения с метками, которые соответствуют всем указанным идентификаторам меток. Сообщения в потоке могут иметь метки, которых нет у других сообщений в том же потоке. Чтобы узнать больше, см. Управление метками сообщений и потоков . |
includeSpamTrash | boolean Включить в результаты сообщения из SPAM и TRASH . |
Текст запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит данные со следующей структурой:
| JSON-представление |
|---|
{
"messages": [
{
object (Message)
}
],
"nextPageToken": string,
"resultSizeEstimate": integer
} |
| Поля |
|---|
messages[] | object ( Message ) Список сообщений. Обратите внимание, что каждый ресурс сообщения содержит только id и threadId . Дополнительные сведения о сообщении можно получить с помощью метода messages.get . |
nextPageToken | string Токен для получения следующей страницы результатов в списке. |
resultSizeEstimate | integer ( uint32 format) Предполагаемое общее количество результатов. |
Области действия авторизации
Требуется одна из следующих областей 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.metadata
Более подробную информацию см. в Руководстве по авторизации .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 2025-07-25 UTC."],[],[],null,["# Method: users.messages.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListMessagesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the messages in the user's mailbox. For example usage, see [List Gmail messages](https://developers.google.com/workspace/gmail/api/guides/list-messages).\n\n### HTTP request\n\n`GET https://gmail.googleapis.com/gmail/v1/users/{userId}/messages`\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### Query parameters\n\n| Parameters ||\n|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `maxResults` | `integer (`[uint32](https://developers.google.com/discovery/v1/type-format)` format)` Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500. |\n| `pageToken` | `string` Page token to retrieve a specific page of results in the list. |\n| `q` | `string` Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid:\u003csomemsgid@example.com\u003e is:unread\"`. Parameter cannot be used when accessing the api using the gmail.metadata scope. |\n| `labelIds[]` | `string` Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't have. To learn more, see [Manage labels on messages and threads](https://developers.google.com/workspace/gmail/api/guides/labels#manage_labels_on_messages_threads). |\n| `includeSpamTrash` | `boolean` Include messages from `SPAM` and `TRASH` in the results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"messages\": [ { object (/workspace/gmail/api/reference/rest/v1/users.messages#Message) } ], \"nextPageToken\": string, \"resultSizeEstimate\": integer } ``` |\n\n| Fields ||\n|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `messages[]` | `object (`[Message](/workspace/gmail/api/reference/rest/v1/users.messages#Message)`)` List of messages. Note that each message resource contains only an `id` and a `threadId`. Additional message details can be fetched using the [messages.get](/workspace/gmail/api/v1/reference/users/messages/get) method. |\n| `nextPageToken` | `string` Token to retrieve the next page of results in the list. |\n| `resultSizeEstimate` | `integer (`[uint32](https://developers.google.com/discovery/v1/type-format)` format)` Estimated total number of results. |\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.readonly`\n- `\n https://www.googleapis.com/auth/gmail.metadata`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
