Dokumen ini menjelaskan cara membuat kueri dan menemukan pesan menggunakan Gmail API.
Anda dapat menelusuri atau memfilter file menggunakan metode
messages.list
dan threads.list. Metode ini menerima parameter kueri q, yang mendukung sebagian besar
sintaks penelusuran lanjutan yang sama seperti
antarmuka web Gmail. Untuk melihat daftar perbedaan penelusuran dan pemfilteran antara UI Gmail dan Gmail API, lihat Perbedaan dari UI Gmail.
Sintaksis penelusuran lanjutan ini memungkinkan Anda menggunakan kueri untuk memfilter pesan menurut properti seperti pengirim, tanggal, atau label. Misalnya, kueri metode
messages.list berikut mengambil semua pesan yang dikirim oleh pengguna pada Januari
2014:
GET https://www.googleapis.com/gmail/v1/users/me/messages?q=in:sent after:2014/01/01 before:2014/02/01
Selain kueri penelusuran, Anda juga dapat memfilter pesan dan rangkaian pesan menurut label dengan parameter labelIds[]. Dengan alat ini, Anda dapat menelusuri pesan dan rangkaian pesan
dengan label sistem atau pengguna tertentu yang diterapkan. Untuk mengetahui informasi selengkapnya, lihat metode
messages.list dan threads.list. Untuk mengetahui informasi selengkapnya tentang label, lihat Mengelola label.
Perbedaan dari UI Gmail
Meskipun Gmail API mendukung sebagian besar sintaks penelusuran lanjutan yang digunakan di UI Gmail, ada beberapa perbedaan:
UI Gmail melakukan perluasan alias, yang memungkinkannya menyimpulkan alias akun dari akun Google Workspace. Misalnya, Anda memiliki akun
myprimary@cymbalgroup.comdan administrator Anda menyiapkan alias untuk akun tersebut, yaitumyalias@cymbalgroup.com. Jikamyalias@cymbalgroup.commengirim email, tetapi Anda menelusuri "myalias@cymbalgroup.com", email yang dikirim olehmyalias@cymbalgroup.comakan muncul di hasil penelusuran di UI Gmail, tetapi tidak di respons API.from: myprimary@cymbalgroup.comUI Gmail memungkinkan pengguna melakukan penelusuran di seluruh rangkaian pesan, tetapi API tidak.