Method: users.threads.list

Перечисляет потоки в почтовом ящике пользователя.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
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-представление
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Поля
threads[]

object ( Thread )

Список тем. Обратите внимание, что каждый ресурс потока не содержит списка messages . Список messages для данного потока можно получить с помощью метода threads.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

Дополнительную информацию см. в руководстве по авторизации .