Method: users.threads.list

Mencantumkan rangkaian pesan di kotak surat pengguna.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
userId

string

Alamat email pengguna. Nilai khusus me dapat digunakan untuk menunjukkan pengguna terautentikasi.

Parameter kueri

Parameter
maxResults

integer (uint32 format)

Jumlah maksimum thread yang akan ditampilkan. Kolom ini ditetapkan secara default ke 100. Nilai maksimum yang diizinkan untuk kolom ini adalah 500.
pageToken

string

Token halaman untuk mengambil halaman hasil tertentu dalam daftar.
q

string

Hanya tampilkan thread yang cocok dengan kueri yang ditentukan. Mendukung format kueri yang sama dengan kotak penelusuran Gmail. Misalnya, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Parameter tidak dapat digunakan saat mengakses api menggunakan cakupan gmail.metadata.
labelIds[]

string

Hanya tampilkan rangkaian pesan dengan label yang cocok dengan semua ID label yang ditentukan.
includeSpamTrash

boolean

Sertakan rangkaian pesan dari SPAM dan TRASH dalam hasil.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

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

object (Thread)

Daftar rangkaian pesan. Perlu diperhatikan bahwa setiap resource thread tidak berisi daftar messages. Daftar messages untuk thread tertentu dapat diambil menggunakan metode threads.get.
nextPageToken

string

Token halaman untuk mengambil halaman hasil berikutnya dalam daftar.
resultSizeEstimate

integer (uint32 format)

Estimasi jumlah total hasil.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • 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

Untuk informasi selengkapnya, lihat Panduan otorisasi.