Method: users.threads.list

Zawiera listę wątków w skrzynce pocztowej użytkownika.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
userId

string

Adres e-mail użytkownika. Do wskazywania uwierzytelnionego użytkownika można użyć wartości specjalnej me.

Parametry zapytania

Parametry
maxResults

integer (uint32 format)

Maksymalna liczba wątków do zwrócenia. Domyślna wartość w tym polu to 100. Maksymalna dozwolona wartość w tym polu to 500.
pageToken

string

Token strony, który pozwala pobrać konkretną stronę wyników na liście.
q

string

Zwraca tylko wątki pasujące do określonego zapytania. Obsługuje ten sam format zapytania co pole wyszukiwania w Gmailu. Na przykład: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Parametru nie można używać podczas uzyskiwania dostępu do interfejsu API za pomocą zakresu gmail.metadata.
labelIds[]

string

Zwraca tylko wątki z etykietami, które pasują do wszystkich podanych identyfikatorów etykiet.
includeSpamTrash

boolean

W wynikach uwzględnij wątki z języków: SPAM i TRASH.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Pola
threads[]

object (Thread)

Lista wątków. Pamiętaj, że każdy zasób wątku nie zawiera listy messages. Listę messages w danym wątku można pobrać przy użyciu metody threads.get.
nextPageToken

string

Token strony, który pozwala pobrać następną stronę wyników na liście.
resultSizeEstimate

integer (uint32 format)

Szacunkowa łączna liczba wyników.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.