- Permintaan HTTP
- Parameter lokasi
- Parameter kueri
- Isi permintaan
- Isi respons
- Cakupan otorisasi
- HistoryType
- Sejarah
- MessageAdded
- MessageDeleted
- LabelAdded
- LabelRemoved
- Cobalah!
Mencantumkan histori semua perubahan ke kotak surat tertentu. Hasil histori ditampilkan dalam urutan kronologis (meningkatkan historyId
).
Permintaan HTTP
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/history
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
userId |
Alamat email pengguna. Nilai khusus |
Parameter kueri
Parameter | |
---|---|
maxResults |
Jumlah maksimum catatan histori untuk ditampilkan. Kolom ini ditetapkan secara default ke 100. Nilai maksimum yang diizinkan untuk kolom ini adalah 500. |
pageToken |
Token halaman untuk mengambil halaman hasil tertentu dalam daftar. |
startHistoryId |
Wajib diisi. Menampilkan catatan histori setelah |
labelId |
Hanya tampilkan pesan dengan label yang cocok dengan ID. |
historyTypes[] |
Jenis histori yang akan ditampilkan oleh fungsi |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{
"history": [
{
object ( |
Kolom | |
---|---|
history[] |
Daftar catatan histori. Setiap |
nextPageToken |
Token halaman untuk mengambil halaman hasil berikutnya dalam daftar. |
historyId |
ID catatan histori kotak surat saat ini. |
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.
HistoryType
Enum | |
---|---|
messageAdded |
|
messageDeleted |
|
labelAdded |
|
labelRemoved |
Histori
Kumpulan data perubahan kotak surat pengguna. Setiap perubahan histori dapat memengaruhi beberapa pesan dengan beberapa cara.
Representasi JSON |
---|
{ "id": string, "messages": [ { object ( |
Kolom | |
---|---|
id |
ID urutan kotak surat. |
messages[] |
Daftar pesan yang diubah dalam catatan histori ini. Kolom untuk jenis perubahan tertentu, seperti |
messagesAdded[] |
Pesan ditambahkan ke kotak surat dalam catatan histori ini. |
messagesDeleted[] |
Pesan dihapus (tidak Dibuang) dari kotak surat dalam catatan histori ini. |
labelsAdded[] |
Label ditambahkan ke pesan dalam catatan histori ini. |
labelsRemoved[] |
Label dihapus dari pesan dalam catatan histori ini. |
MessageAdded
Representasi JSON |
---|
{
"message": {
object ( |
Kolom | |
---|---|
message |
|
MessageDeleted
Representasi JSON |
---|
{
"message": {
object ( |
Kolom | |
---|---|
message |
|
LabelAdded
Representasi JSON |
---|
{
"message": {
object ( |
Kolom | |
---|---|
message |
|
labelIds[] |
ID label ditambahkan ke pesan. |
LabelRemoved
Representasi JSON |
---|
{
"message": {
object ( |
Kolom | |
---|---|
message |
|
labelIds[] |
ID label dihapus dari pesan. |